Package org.opensearch.client.opensearch.indices

Class IndicesStatsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.IndicesStatsRequest
All Implemented Interfaces:
ToCopyableBuilder<IndicesStatsRequest.Builder,IndicesStatsRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class IndicesStatsRequest extends RequestBase implements ToCopyableBuilder<IndicesStatsRequest.Builder,IndicesStatsRequest>
Provides statistics on operations happening in an index.

  • Field Details

  • Method Details

    • of

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

    • completionFields

      @Nonnull public final List<String> completionFields()
      Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics.

      API name: completion_fields

    • expandWildcards

      @Nonnull 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

    • fielddataFields

      @Nonnull public final List<String> fielddataFields()
      Comma-separated list or wildcard expressions of fields to include in field data statistics.

      API name: fielddata_fields

    • fields

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

      API name: fields

    • forbidClosedIndices

      @Nullable public final Boolean forbidClosedIndices()
      If true, statistics are not collected from closed indexes.

      API name: forbid_closed_indices

    • groups

      @Nonnull public final List<String> groups()
      Comma-separated list of search groups to include in the search statistics.

      API name: groups

    • includeSegmentFileSizes

      @Nullable public final Boolean includeSegmentFileSizes()
      If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

      API name: include_segment_file_sizes

    • includeUnloadedSegments

      @Nullable public final Boolean includeUnloadedSegments()
      If true, the response includes information from segments that are not loaded into memory.

      API name: include_unloaded_segments

    • index

      @Nonnull public final List<String> index()
      A comma-separated list of index names; use _all or empty string to perform the operation on all indexes

      API name: index

    • level

      @Nullable public final Level level()
      Indicates whether statistics are aggregated at the cluster, index, or shard level.

      API name: level

    • metric

      @Nonnull public final List<IndicesStatsMetric> metric()
      Limit the information returned the specific metrics.

      API name: metric

    • toBuilder

      @Nonnull public IndicesStatsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IndicesStatsRequest.Builder,IndicesStatsRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static IndicesStatsRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object