Package org.opensearch.client.opensearch.indices

Class IndicesStatsRequest

  • public class IndicesStatsRequest
extends RequestBase
    Provides statistics on operations happening in an index.

    • Method Detail

      • completionFields

        public final java.util.List<java.lang.String> completionFields()
        A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

        API name: completion_fields

      • expandWildcards

        public final java.util.List<ExpandWildcard> expandWildcards()
        Whether to expand wildcard expression to concrete indices that are open, closed or both.

        API name: expand_wildcards

      • fielddataFields

        public final java.util.List<java.lang.String> fielddataFields()
        A comma-separated list of fields for fielddata index metric (supports wildcards)

        API name: fielddata_fields

      • fields

        public final java.util.List<java.lang.String> fields()
        A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

        API name: fields

      • forbidClosedIndices

        @Nullable
public final java.lang.Boolean forbidClosedIndices()
        If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices

        API name: forbid_closed_indices

      • groups

        public final java.util.List<java.lang.String> groups()
        A comma-separated list of search groups for search index metric

        API name: groups

      • includeSegmentFileSizes

        @Nullable
public final java.lang.Boolean includeSegmentFileSizes()
        Whether to report 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 java.lang.Boolean includeUnloadedSegments()
        If set to true segment stats will include stats for segments that are not currently loaded into memory

        API name: include_unloaded_segments

      • index

        public final java.util.List<java.lang.String> index()
        A comma-separated list of index names; use _all or empty string to perform the operation on all indices

        API name: index

      • level

        @Nullable
public final Level level()
        Return stats aggregated at cluster, index or shard level

        API name: level

      • metric

        public final java.util.List<java.lang.String> metric()
        Limit the information returned the specific metrics.

        API name: metric

      • types

        public final java.util.List<java.lang.String> types()
        A comma-separated list of document types for the indexing index metric

        API name: types