Package co.elastic.clients.elasticsearch.indices

Class FieldUsageStatsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.FieldUsageStatsRequest
public class FieldUsageStatsRequest extends RequestBase
Get field usage stats.

Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.

The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.

See Also:

  • Field Details

  • Method Details

    • of

      public static FieldUsageStatsRequest of(Function<FieldUsageStatsRequest.Builder,ObjectBuilder<FieldUsageStatsRequest>> fn)

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

    • fields

      public final List<String> fields()
      Comma-separated list or wildcard expressions of fields to include in the statistics.

      API name: fields

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      Required - Comma-separated list or wildcard expression of index names used to limit the request.

      API name: index

    • rebuild

      public FieldUsageStatsRequest.Builder rebuild()
      Returns:
      New FieldUsageStatsRequest.Builder initialized with field values of this instance