Class StatsRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch.indices.StatsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<StatsRequest>
- Enclosing class:
- StatsRequest
public static class StatsRequest.Builder extends java.lang.Object implements ObjectBuilder<StatsRequest>
Builder for
StatsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description StatsRequest.Builder
addCompletionFields(java.lang.String value)
Add a value tocompletionFields(List)
, creating the list if needed.StatsRequest.Builder
addExpandWildcards(ExpandWildcardOptions value)
Add a value toexpandWildcards(List)
, creating the list if needed.StatsRequest.Builder
addFielddataFields(java.lang.String value)
Add a value tofielddataFields(List)
, creating the list if needed.StatsRequest.Builder
addFields(java.lang.String value)
Add a value tofields(List)
, creating the list if needed.StatsRequest.Builder
addGroups(java.lang.String value)
Add a value togroups(List)
, creating the list if needed.StatsRequest.Builder
addIndex(java.lang.String value)
Add a value toindex(List)
, creating the list if needed.StatsRequest.Builder
addMetric(java.lang.String value)
Add a value tometric(List)
, creating the list if needed.StatsRequest.Builder
addTypes(java.lang.String value)
Add a value totypes(List)
, creating the list if needed.StatsRequest
build()
Builds aStatsRequest
.StatsRequest.Builder
completionFields(java.lang.String... value)
A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)StatsRequest.Builder
completionFields(java.util.List<java.lang.String> value)
A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)StatsRequest.Builder
expandWildcards(ExpandWildcardOptions... value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.StatsRequest.Builder
expandWildcards(java.util.List<ExpandWildcardOptions> value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.StatsRequest.Builder
fielddataFields(java.lang.String... value)
A comma-separated list of fields forfielddata
index metric (supports wildcards)StatsRequest.Builder
fielddataFields(java.util.List<java.lang.String> value)
A comma-separated list of fields forfielddata
index metric (supports wildcards)StatsRequest.Builder
fields(java.lang.String... value)
A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)StatsRequest.Builder
fields(java.util.List<java.lang.String> value)
A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)StatsRequest.Builder
forbidClosedIndices(java.lang.Boolean value)
If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indicesStatsRequest.Builder
groups(java.lang.String... value)
A comma-separated list of search groups forsearch
index metricStatsRequest.Builder
groups(java.util.List<java.lang.String> value)
A comma-separated list of search groups forsearch
index metricStatsRequest.Builder
includeSegmentFileSizes(java.lang.Boolean value)
Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)StatsRequest.Builder
includeUnloadedSegments(java.lang.Boolean value)
If set to true segment stats will include stats for segments that are not currently loaded into memoryStatsRequest.Builder
index(java.lang.String... value)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesStatsRequest.Builder
index(java.util.List<java.lang.String> value)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesStatsRequest.Builder
level(Level value)
Return stats aggregated at cluster, index or shard levelStatsRequest.Builder
metric(java.lang.String... value)
Limit the information returned the specific metrics.StatsRequest.Builder
metric(java.util.List<java.lang.String> value)
Limit the information returned the specific metrics.StatsRequest.Builder
types(java.lang.String... value)
A comma-separated list of document types for theindexing
index metricStatsRequest.Builder
types(java.util.List<java.lang.String> value)
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
metric
Limit the information returned the specific metrics.API name:
metric
-
metric
Limit the information returned the specific metrics.API name:
metric
-
addMetric
Add a value tometric(List)
, creating the list if needed. -
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
addIndex
Add a value toindex(List)
, creating the list if needed. -
completionFields
A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)API name:
completion_fields
-
completionFields
A comma-separated list of fields forfielddata
andsuggest
index metric (supports wildcards)API name:
completion_fields
-
addCompletionFields
Add a value tocompletionFields(List)
, creating the list if needed. -
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
addExpandWildcards
Add a value toexpandWildcards(List)
, creating the list if needed. -
fielddataFields
A comma-separated list of fields forfielddata
index metric (supports wildcards)API name:
fielddata_fields
-
fielddataFields
A comma-separated list of fields forfielddata
index metric (supports wildcards)API name:
fielddata_fields
-
addFielddataFields
Add a value tofielddataFields(List)
, creating the list if needed. -
fields
A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)API name:
fields
-
fields
A comma-separated list of fields forfielddata
andcompletion
index metric (supports wildcards)API name:
fields
-
addFields
Add a value tofields(List)
, creating the list if needed. -
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
-
groups
A comma-separated list of search groups forsearch
index metricAPI name:
groups
-
addGroups
Add a value togroups(List)
, creating the list if needed. -
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
-
level
Return stats aggregated at cluster, index or shard levelAPI name:
level
-
types
A comma-separated list of document types for theindexing
index metricAPI name:
types
-
types
A comma-separated list of document types for theindexing
index metricAPI name:
types
-
addTypes
Add a value totypes(List)
, creating the list if needed. -
build
Builds aStatsRequest
.- Specified by:
build
in interfaceObjectBuilder<StatsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-