Class StateRequest
The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.
The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response.
By default the API will route requests to the elected master node since this
node is the authoritative source of cluster states. You can also retrieve the
cluster state held on the node handling the API request by adding the
?local=true
query parameter.
Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable.
WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs.
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Endpoint<StateRequest,
StateResponse, ErrorResponse> Endpoint "cluster.state
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
Return settings in flat format (default: false)final Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)index()
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesfinal Boolean
local()
Return local information, do not retrieve the state from master node (default: false)final Time
Specify timeout for connection to mastermetric()
Limit the information returned to the specified metricsstatic StateRequest
final Long
Wait for the metadata version to be equal or greater than the specified metadata versionfinal Time
The maximum time to wait for wait_for_metadata_version before timing outMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cluster.state
".
-
-
Method Details
-
of
-
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
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
flatSettings
Return settings in flat format (default: false)API name:
flat_settings
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
local
Return local information, do not retrieve the state from master node (default: false)API name:
local
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
metric
Limit the information returned to the specified metricsAPI name:
metric
-
waitForMetadataVersion
Wait for the metadata version to be equal or greater than the specified metadata versionAPI name:
wait_for_metadata_version
-
waitForTimeout
The maximum time to wait for wait_for_metadata_version before timing outAPI name:
wait_for_timeout
-