Package org.opensearch.client.opensearch.indices

Class IndicesStatsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndicesStatsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<IndicesStatsRequest>

Enclosing class:

IndicesStatsRequest

public static class IndicesStatsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<IndicesStatsRequest>

Builder for IndicesStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndicesStatsRequest	build()	Builds a IndicesStatsRequest.
IndicesStatsRequest.Builder	completionFields(java.lang.String value, java.lang.String... values)	A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)
IndicesStatsRequest.Builder	completionFields(java.util.List<java.lang.String> list)	A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)
IndicesStatsRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
IndicesStatsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
IndicesStatsRequest.Builder	fielddataFields(java.lang.String value, java.lang.String... values)	A comma-separated list of fields for fielddata index metric (supports wildcards)
IndicesStatsRequest.Builder	fielddataFields(java.util.List<java.lang.String> list)	A comma-separated list of fields for fielddata index metric (supports wildcards)
IndicesStatsRequest.Builder	fields(java.lang.String value, java.lang.String... values)	A comma-separated list of fields for fielddata and completion index metric (supports wildcards)
IndicesStatsRequest.Builder	fields(java.util.List<java.lang.String> list)	A comma-separated list of fields for fielddata and completion index metric (supports wildcards)
IndicesStatsRequest.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 indices
IndicesStatsRequest.Builder	groups(java.lang.String value, java.lang.String... values)	A comma-separated list of search groups for search index metric
IndicesStatsRequest.Builder	groups(java.util.List<java.lang.String> list)	A comma-separated list of search groups for search index metric
IndicesStatsRequest.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)
IndicesStatsRequest.Builder	includeUnloadedSegments(java.lang.Boolean value)	If set to true segment stats will include stats for segments that are not currently loaded into memory
IndicesStatsRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
IndicesStatsRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
IndicesStatsRequest.Builder	level(Level value)	Return stats aggregated at cluster, index or shard level
IndicesStatsRequest.Builder	metric(java.lang.String value, java.lang.String... values)	Limit the information returned the specific metrics.
IndicesStatsRequest.Builder	metric(java.util.List<java.lang.String> list)	Limit the information returned the specific metrics.
IndicesStatsRequest.Builder	types(java.lang.String value, java.lang.String... values)	A comma-separated list of document types for the indexing index metric
IndicesStatsRequest.Builder	types(java.util.List<java.lang.String> list)	A comma-separated list of document types for the indexing index metric

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

completionFields

public final IndicesStatsRequest.Builder completionFields(java.util.List<java.lang.String> list)

A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

API name: completion_fields

Adds all elements of list to completionFields.

completionFields

public final IndicesStatsRequest.Builder completionFields(java.lang.String value,
                                                          java.lang.String... values)

A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

API name: completion_fields

Adds one or more values to completionFields.

expandWildcards

public final IndicesStatsRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

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

public final IndicesStatsRequest.Builder fielddataFields(java.util.List<java.lang.String> list)

A comma-separated list of fields for fielddata index metric (supports wildcards)

API name: fielddata_fields

Adds all elements of list to fielddataFields.

fielddataFields

public final IndicesStatsRequest.Builder fielddataFields(java.lang.String value,
                                                         java.lang.String... values)

A comma-separated list of fields for fielddata index metric (supports wildcards)

API name: fielddata_fields

Adds one or more values to fielddataFields.

fields

public final IndicesStatsRequest.Builder fields(java.util.List<java.lang.String> list)

A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

API name: fields

Adds all elements of list to fields.

fields

public final IndicesStatsRequest.Builder fields(java.lang.String value,
                                                java.lang.String... values)

A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

API name: fields

Adds one or more values to fields.

forbidClosedIndices

public final IndicesStatsRequest.Builder forbidClosedIndices(@Nullable
                                                             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 indices

API name: forbid_closed_indices

groups

public final IndicesStatsRequest.Builder groups(java.util.List<java.lang.String> list)

A comma-separated list of search groups for search index metric

API name: groups

Adds all elements of list to groups.

groups

public final IndicesStatsRequest.Builder groups(java.lang.String value,
                                                java.lang.String... values)

A comma-separated list of search groups for search index metric

API name: groups

Adds one or more values to groups.

includeSegmentFileSizes

public final IndicesStatsRequest.Builder includeSegmentFileSizes(@Nullable
                                                                 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)

API name: include_segment_file_sizes

includeUnloadedSegments

public final IndicesStatsRequest.Builder includeUnloadedSegments(@Nullable
                                                                 java.lang.Boolean value)

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 IndicesStatsRequest.Builder index(java.util.List<java.lang.String> list)

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

public final IndicesStatsRequest.Builder index(java.lang.String value,
                                               java.lang.String... values)

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

level

public final IndicesStatsRequest.Builder level(@Nullable
                                               Level value)

Return stats aggregated at cluster, index or shard level

API name: level

metric

public final IndicesStatsRequest.Builder metric(java.util.List<java.lang.String> list)

Limit the information returned the specific metrics.

API name: metric

Adds all elements of list to metric.

metric

public final IndicesStatsRequest.Builder metric(java.lang.String value,
                                                java.lang.String... values)

Limit the information returned the specific metrics.

API name: metric

Adds one or more values to metric.

types

public final IndicesStatsRequest.Builder types(java.util.List<java.lang.String> list)

A comma-separated list of document types for the indexing index metric

API name: types

Adds all elements of list to types.

types

public final IndicesStatsRequest.Builder types(java.lang.String value,
                                               java.lang.String... values)

A comma-separated list of document types for the indexing index metric

API name: types

Adds one or more values to types.

build

public IndicesStatsRequest build()

Builds a IndicesStatsRequest.

Specified by:

build in interface ObjectBuilder<IndicesStatsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.