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()
A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)java.util.List<ExpandWildcard>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.java.util.List<java.lang.String>
fielddataFields()
A comma-separated list of fields forfielddata
index metric (supports wildcards)java.util.List<java.lang.String>
fields()
A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)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 indicesjava.util.List<java.lang.String>
groups()
A comma-separated list of search groups forsearch
index metricjava.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)java.lang.Boolean
includeUnloadedSegments()
If set to true segment stats will include stats for segments that are not currently loaded into memoryjava.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()
Return stats aggregated at cluster, index or shard leveljava.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)
java.util.List<java.lang.String>
types()
A comma-separated list of document types for theindexing
index metricMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)API name:
completion_fields
-
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 forfielddata
index metric (supports wildcards)API name:
fielddata_fields
-
fields
public final java.util.List<java.lang.String> fields()A comma-separated list of fields forfielddata
andcompletion
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 indicesAPI name:
forbid_closed_indices
-
groups
public final java.util.List<java.lang.String> groups()A comma-separated list of search groups forsearch
index metricAPI 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 memoryAPI 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
Return stats aggregated at cluster, index or shard levelAPI 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 theindexing
index metricAPI name:
types
-