Class StateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.StateRequest
Returns a comprehensive information about the state of the cluster.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier 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
-