Package org.opensearch.client.opensearch.cluster

Class StateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<StateRequest>

Enclosing class:

StateRequest

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

Builder for StateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StateRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
StateRequest	build()	Builds a StateRequest.
StateRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
StateRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
StateRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
StateRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
StateRequest.Builder	flatSettings(java.lang.Boolean value)	Return settings in flat format (default: false)
StateRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
StateRequest.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
StateRequest.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
StateRequest.Builder	local(java.lang.Boolean value)	Return local information, do not retrieve the state from cluster-manager node (default: false)
StateRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
StateRequest.Builder	masterTimeout(Time value)	Deprecated.
StateRequest.Builder	metric(java.lang.String value, java.lang.String... values)	Limit the information returned to the specified metrics
StateRequest.Builder	metric(java.util.List<java.lang.String> list)	Limit the information returned to the specified metrics
StateRequest.Builder	waitForMetadataVersion(java.lang.Long value)	Wait for the metadata version to be equal or greater than the specified metadata version
StateRequest.Builder	waitForTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	The maximum time to wait for wait_for_metadata_version before timing out
StateRequest.Builder	waitForTimeout(Time value)	The maximum time to wait for wait_for_metadata_version before timing out

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

allowNoIndices

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

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final StateRequest.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 StateRequest.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.

flatSettings

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

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final StateRequest.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 StateRequest.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.

local

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

Return local information, do not retrieve the state from cluster-manager node (default: false)

API name: local

masterTimeout

@Deprecated
public final StateRequest.Builder masterTimeout(@Nullable
                                                Time value)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final StateRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

public final StateRequest.Builder clusterManagerTimeout(@Nullable
                                                        Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final StateRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

metric

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

Limit the information returned to the specified metrics

API name: metric

Adds all elements of list to metric.

metric

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

Limit the information returned to the specified metrics

API name: metric

Adds one or more values to metric.

waitForMetadataVersion

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

Wait for the metadata version to be equal or greater than the specified metadata version

API name: wait_for_metadata_version

waitForTimeout

public final StateRequest.Builder waitForTimeout(@Nullable
                                                 Time value)

The maximum time to wait for wait_for_metadata_version before timing out

API name: wait_for_timeout

waitForTimeout

public final StateRequest.Builder waitForTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

The maximum time to wait for wait_for_metadata_version before timing out

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.