Package org.opensearch.client.opensearch.cluster

Class StateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.StateRequest

public class StateRequest
extends RequestBase

Returns a comprehensive information about the state of the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StateRequest.Builder	Builder for StateRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<StateRequest,StateResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.state".

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<StateRequest,StateResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.state".

Method Detail

of

public static StateRequest of(java.util.function.Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)

allowNoIndices

@Nullable
public final java.lang.Boolean allowNoIndices()

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 java.util.List<ExpandWildcard> expandWildcards()

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

API name: expand_wildcards

flatSettings

@Nullable
public final java.lang.Boolean flatSettings()

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

index

public final java.util.List<java.lang.String> index()

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

API name: index

local

@Nullable
public final java.lang.Boolean local()

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

API name: local

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

metric

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

Limit the information returned to the specified metrics

API name: metric

waitForMetadataVersion

@Nullable
public final java.lang.Long waitForMetadataVersion()

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

API name: wait_for_metadata_version

waitForTimeout

@Nullable
public final Time waitForTimeout()

The maximum time to wait for wait_for_metadata_version before timing out

API name: wait_for_timeout