Package org.opensearch.client.opensearch.cluster

Class StateRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.cluster.StateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<StateRequest>

Enclosing class:

StateRequest

public static class StateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<StateRequest>

Builder for StateRequest.

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
StateRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
StateRequest.Builder	addMetric(java.lang.String value)	Add a value to metric(List), creating the list if needed.
StateRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
StateRequest	build()	Builds a StateRequest.
StateRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
StateRequest.Builder	flatSettings(java.lang.Boolean value)	API name: flat_settings
StateRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
StateRequest.Builder	index(java.lang.String... value)	API name: index
StateRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
StateRequest.Builder	local(java.lang.Boolean value)	API name: local
StateRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	API name: master_timeout
StateRequest.Builder	metric(java.lang.String... value)	API name: metric
StateRequest.Builder	metric(java.util.List<java.lang.String> value)	API name: metric
StateRequest.Builder	waitForMetadataVersion(java.lang.Number value)	API name: wait_for_metadata_version
StateRequest.Builder	waitForTimeout(jakarta.json.JsonValue value)	API name: wait_for_timeout

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 StateRequest.Builder metric(@Nullable java.util.List<java.lang.String> value)

API name: metric

metric

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

API name: metric

addMetric

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

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

index

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

API name: index

index

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

API name: index

addIndex

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

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

allowNoIndices

public StateRequest.Builder allowNoIndices(@Nullable java.lang.Boolean value)

API name: allow_no_indices

expandWildcards

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

API name: expand_wildcards

flatSettings

public StateRequest.Builder flatSettings(@Nullable java.lang.Boolean value)

API name: flat_settings

ignoreUnavailable

public StateRequest.Builder ignoreUnavailable(@Nullable java.lang.Boolean value)

API name: ignore_unavailable

local

public StateRequest.Builder local(@Nullable java.lang.Boolean value)

API name: local

masterTimeout

public StateRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

API name: master_timeout

waitForMetadataVersion

public StateRequest.Builder waitForMetadataVersion(@Nullable java.lang.Number value)

API name: wait_for_metadata_version

waitForTimeout

public StateRequest.Builder waitForTimeout(@Nullable jakarta.json.JsonValue value)

API name: wait_for_timeout

build

public StateRequest build()

Builds a StateRequest.

Specified by:

build in interface ObjectBuilder<StateRequest>

Throws:

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