Class IndicesStatsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.IndicesStatsRequest
public class IndicesStatsRequest extends RequestBase
Provides statistics on operations happening in an index.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IndicesStatsRequest.Builder
Builder forIndicesStatsRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<IndicesStatsRequest,IndicesStatsResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.stats
". -
Method Summary
Modifier and Type Method Description java.util.List<java.lang.String>
completionFields()
Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.java.util.List<ExpandWildcard>
expandWildcards()
Type of index that wildcard patterns can match.java.util.List<java.lang.String>
fielddataFields()
Comma-separated list or wildcard expressions of fields to include in fielddata statistics.java.util.List<java.lang.String>
fields()
Comma-separated list or wildcard expressions of fields to include in the statistics.java.lang.Boolean
forbidClosedIndices()
If true, statistics are not collected from closed indices.java.util.List<java.lang.String>
groups()
Comma-separated list of search groups to include in the search statistics.java.lang.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).java.lang.Boolean
includeUnloadedSegments()
If true, the response includes information from segments that are not loaded into memory.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 indicesLevel
level()
Indicates whether statistics are aggregated at the cluster, index, or shard level.java.util.List<java.lang.String>
metric()
Limit the information returned the specific metrics.static IndicesStatsRequest
of(java.util.function.Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "indices.stats
".
-
-
Method Details
-
of
public static IndicesStatsRequest of(java.util.function.Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn) -
completionFields
public final java.util.List<java.lang.String> completionFields()Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.API name:
completion_fields
-
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 asopen,hidden
.API name:
expand_wildcards
-
fielddataFields
public final java.util.List<java.lang.String> fielddataFields()Comma-separated list or wildcard expressions of fields to include in fielddata statistics.API name:
fielddata_fields
-
fields
public final java.util.List<java.lang.String> fields()Comma-separated list or wildcard expressions of fields to include in the statistics.API name:
fields
-
forbidClosedIndices
@Nullable public final java.lang.Boolean forbidClosedIndices()If true, statistics are not collected from closed indices.API name:
forbid_closed_indices
-
groups
public final java.util.List<java.lang.String> groups()Comma-separated list of search groups to include in the search statistics.API name:
groups
-
includeSegmentFileSizes
@Nullable public final java.lang.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 java.lang.Boolean includeUnloadedSegments()If true, the response includes information from segments that are not 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 indicesAPI name:
index
-
level
Indicates whether statistics are aggregated at the 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
-