Class IndicesStatsRequest.Builder
- All Implemented Interfaces:
WithJson<IndicesStatsRequest.Builder>
,ObjectBuilder<IndicesStatsRequest>
- Enclosing class:
- IndicesStatsRequest
IndicesStatsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aIndicesStatsRequest
.completionFields
(String value, String... values) A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)completionFields
(List<String> list) A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.fielddataFields
(String value, String... values) A comma-separated list of fields forfielddata
index metric (supports wildcards)fielddataFields
(List<String> list) A comma-separated list of fields forfielddata
index metric (supports wildcards)A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)forbidClosedIndices
(Boolean value) If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indicesA comma-separated list of search groups forsearch
index metricA comma-separated list of search groups forsearch
index metricincludeSegmentFileSizes
(Boolean value) Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)includeUnloadedSegments
(Boolean value) If set to true segment stats will include stats for segments that are not currently loaded into memoryA comma-separated list of index names; use_all
or empty string to perform the operation on all indicesA comma-separated list of index names; use_all
or empty string to perform the operation on all indicesReturn stats aggregated at cluster, index or shard levelLimit the information returned the specific metrics.Limit the information returned the specific metrics.protected IndicesStatsRequest.Builder
self()
A comma-separated list of document types for theindexing
index metricA comma-separated list of document types for theindexing
index metricMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
completionFields
A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)API name:
completion_fields
Adds all elements of
list
tocompletionFields
. -
completionFields
A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)API name:
completion_fields
Adds one or more values to
completionFields
. -
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final IndicesStatsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
fielddataFields
A comma-separated list of fields forfielddata
index metric (supports wildcards)API name:
fielddata_fields
Adds all elements of
list
tofielddataFields
. -
fielddataFields
A comma-separated list of fields forfielddata
index metric (supports wildcards)API name:
fielddata_fields
Adds one or more values to
fielddataFields
. -
fields
A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)API name:
fields
Adds all elements of
list
tofields
. -
fields
A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)API name:
fields
Adds one or more values to
fields
. -
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
A comma-separated list of search groups forsearch
index metricAPI name:
groups
Adds all elements of
list
togroups
. -
groups
A comma-separated list of search groups forsearch
index metricAPI name:
groups
Adds one or more values to
groups
. -
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
If set to true segment stats will include stats for segments that are not currently loaded into memoryAPI name:
include_unloaded_segments
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds all elements of
list
toindex
. -
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds one or more values to
index
. -
level
Return stats aggregated at cluster, index or shard levelAPI name:
level
-
metric
Limit the information returned the specific metrics.API name:
metric
Adds all elements of
list
tometric
. -
metric
Limit the information returned the specific metrics.API name:
metric
Adds one or more values to
metric
. -
types
A comma-separated list of document types for theindexing
index metricAPI name:
types
Adds all elements of
list
totypes
. -
types
A comma-separated list of document types for theindexing
index metricAPI name:
types
Adds one or more values to
types
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<IndicesStatsRequest.Builder>
-
build
Builds aIndicesStatsRequest
.- Specified by:
build
in interfaceObjectBuilder<IndicesStatsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-