Package org.opensearch.client.opensearch.indices

Class StatsRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StatsRequest.Builder	addCompletionFields(java.lang.String value)	Add a value to completionFields(List), creating the list if needed.
StatsRequest.Builder	addFielddataFields(java.lang.String value)	Add a value to fielddataFields(List), creating the list if needed.
StatsRequest.Builder	addFields(java.lang.String value)	Add a value to fields(List), creating the list if needed.
StatsRequest.Builder	addGroups(java.lang.String value)	Add a value to groups(List), creating the list if needed.
StatsRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
StatsRequest.Builder	addMetric(java.lang.String value)	Add a value to metric(List), creating the list if needed.
StatsRequest.Builder	addTypes(java.lang.String value)	Add a value to types(List), creating the list if needed.
StatsRequest	build()	Builds a StatsRequest.
StatsRequest.Builder	completionFields(java.lang.String... value)	API name: completion_fields
StatsRequest.Builder	completionFields(java.util.List<java.lang.String> value)	API name: completion_fields
StatsRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
StatsRequest.Builder	fielddataFields(java.lang.String... value)	API name: fielddata_fields
StatsRequest.Builder	fielddataFields(java.util.List<java.lang.String> value)	API name: fielddata_fields
StatsRequest.Builder	fields(java.lang.String... value)	API name: fields
StatsRequest.Builder	fields(java.util.List<java.lang.String> value)	API name: fields
StatsRequest.Builder	forbidClosedIndices(java.lang.Boolean value)	API name: forbid_closed_indices
StatsRequest.Builder	groups(java.lang.String... value)	API name: groups
StatsRequest.Builder	groups(java.util.List<java.lang.String> value)	API name: groups
StatsRequest.Builder	includeSegmentFileSizes(java.lang.Boolean value)	API name: include_segment_file_sizes
StatsRequest.Builder	includeUnloadedSegments(java.lang.Boolean value)	API name: include_unloaded_segments
StatsRequest.Builder	index(java.lang.String... value)	API name: index
StatsRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
StatsRequest.Builder	level(jakarta.json.JsonValue value)	API name: level
StatsRequest.Builder	metric(java.lang.String... value)	API name: metric
StatsRequest.Builder	metric(java.util.List<java.lang.String> value)	API name: metric
StatsRequest.Builder	types(java.lang.String... value)	API name: types
StatsRequest.Builder	types(java.util.List<java.lang.String> value)	API name: types

Methods 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

public StatsRequest.Builder metric(@Nullable java.util.List<java.lang.String> value)

API name: metric

metric

public StatsRequest.Builder metric(java.lang.String... value)

API name: metric

addMetric

public StatsRequest.Builder addMetric(java.lang.String value)

Add a value to metric(List), creating the list if needed.

index

public StatsRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

public StatsRequest.Builder index(java.lang.String... value)

API name: index

addIndex

public StatsRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

completionFields

public StatsRequest.Builder completionFields(@Nullable java.util.List<java.lang.String> value)

API name: completion_fields

completionFields

public StatsRequest.Builder completionFields(java.lang.String... value)

API name: completion_fields

addCompletionFields

public StatsRequest.Builder addCompletionFields(java.lang.String value)

Add a value to completionFields(List), creating the list if needed.

expandWildcards

public StatsRequest.Builder expandWildcards(@Nullable jakarta.json.JsonValue value)

API name: expand_wildcards

fielddataFields

public StatsRequest.Builder fielddataFields(@Nullable java.util.List<java.lang.String> value)

API name: fielddata_fields

fielddataFields

public StatsRequest.Builder fielddataFields(java.lang.String... value)

API name: fielddata_fields

addFielddataFields

public StatsRequest.Builder addFielddataFields(java.lang.String value)

Add a value to fielddataFields(List), creating the list if needed.

fields

public StatsRequest.Builder fields(@Nullable java.util.List<java.lang.String> value)

API name: fields

fields

public StatsRequest.Builder fields(java.lang.String... value)

API name: fields

addFields

public StatsRequest.Builder addFields(java.lang.String value)

Add a value to fields(List), creating the list if needed.

forbidClosedIndices

public StatsRequest.Builder forbidClosedIndices(@Nullable java.lang.Boolean value)

API name: forbid_closed_indices

groups

public StatsRequest.Builder groups(@Nullable java.util.List<java.lang.String> value)

API name: groups

groups

public StatsRequest.Builder groups(java.lang.String... value)

API name: groups

addGroups

public StatsRequest.Builder addGroups(java.lang.String value)

Add a value to groups(List), creating the list if needed.

includeSegmentFileSizes

public StatsRequest.Builder includeSegmentFileSizes(@Nullable java.lang.Boolean value)

API name: include_segment_file_sizes

includeUnloadedSegments

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

API name: include_unloaded_segments

level

public StatsRequest.Builder level(@Nullable jakarta.json.JsonValue value)

API name: level

types

public StatsRequest.Builder types(@Nullable java.util.List<java.lang.String> value)

API name: types

types

public StatsRequest.Builder types(java.lang.String... value)

API name: types

addTypes

public StatsRequest.Builder addTypes(java.lang.String value)

Add a value to types(List), creating the list if needed.

build

public StatsRequest build()

Builds a StatsRequest.

Specified by:

build in interface ObjectBuilder<StatsRequest>

Throws:

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