Class ClusterHealthRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<Request>
org.elasticsearch.action.support.master.MasterNodeReadRequest<ClusterHealthRequest>
org.elasticsearch.action.admin.cluster.health.ClusterHealthRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,TaskAwareRequest
public class ClusterHealthRequest extends MasterNodeReadRequest<ClusterHealthRequest> implements IndicesRequest.Replaceable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClusterHealthRequest.Level
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
-
Constructor Summary
Constructors Constructor Description ClusterHealthRequest()
ClusterHealthRequest(java.lang.String... indices)
ClusterHealthRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String[]
indices()
Returns the array of indices that the action relates toClusterHealthRequest
indices(java.lang.String... indices)
Sets the indices that the action relates to.IndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.ClusterHealthRequest
indicesOptions(IndicesOptions indicesOptions)
ClusterHealthRequest.Level
level()
Get the level of detail for the health information to be returned.void
level(ClusterHealthRequest.Level level)
Set the level of detail for the health information to be returned.TimeValue
timeout()
ClusterHealthRequest
timeout(java.lang.String timeout)
ClusterHealthRequest
timeout(TimeValue timeout)
ActionRequestValidationException
validate()
ActiveShardCount
waitForActiveShards()
ClusterHealthRequest
waitForActiveShards(int waitForActiveShards)
A shortcut forwaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.from(int)
to get the ActiveShardCount.ClusterHealthRequest
waitForActiveShards(ActiveShardCount waitForActiveShards)
Sets the number of shard copies that must be active across all indices before getting the health status.Priority
waitForEvents()
ClusterHealthRequest
waitForEvents(Priority waitForEvents)
ClusterHealthRequest
waitForGreenStatus()
java.lang.String
waitForNodes()
ClusterHealthRequest
waitForNodes(java.lang.String waitForNodes)
Waits for N number of nodes.boolean
waitForNoInitializingShards()
ClusterHealthRequest
waitForNoInitializingShards(boolean waitForNoInitializingShards)
Sets whether the request should wait for there to be no initializing shards before retrieving the cluster health status.boolean
waitForNoRelocatingShards()
ClusterHealthRequest
waitForNoRelocatingShards(boolean waitForNoRelocatingShards)
Sets whether the request should wait for there to be no relocating shards before retrieving the cluster health status.ClusterHealthStatus
waitForStatus()
ClusterHealthRequest
waitForStatus(ClusterHealthStatus waitForStatus)
ClusterHealthRequest
waitForYellowStatus()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local, local
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
ClusterHealthRequest
public ClusterHealthRequest() -
ClusterHealthRequest
public ClusterHealthRequest(java.lang.String... indices) -
ClusterHealthRequest
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeReadRequest<ClusterHealthRequest>
- Throws:
java.io.IOException
-
indices
public java.lang.String[] indices()Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
indices
Description copied from interface:IndicesRequest.Replaceable
Sets the indices that the action relates to.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
indicesOptions
Description copied from interface:IndicesRequest
Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.- Specified by:
indicesOptions
in interfaceIndicesRequest
-
indicesOptions
-
timeout
-
timeout
-
timeout
-
waitForStatus
-
waitForStatus
-
waitForGreenStatus
-
waitForYellowStatus
-
waitForNoRelocatingShards
public boolean waitForNoRelocatingShards() -
waitForNoRelocatingShards
Sets whether the request should wait for there to be no relocating shards before retrieving the cluster health status. Defaults tofalse
, meaning the operation does not wait on there being no more relocating shards. Set totrue
to wait until the number of relocating shards in the cluster is 0. -
waitForNoInitializingShards
public boolean waitForNoInitializingShards() -
waitForNoInitializingShards
Sets whether the request should wait for there to be no initializing shards before retrieving the cluster health status. Defaults tofalse
, meaning the operation does not wait on there being no more initializing shards. Set totrue
to wait until the number of initializing shards in the cluster is 0. -
waitForActiveShards
-
waitForActiveShards
Sets the number of shard copies that must be active across all indices before getting the health status. Defaults toActiveShardCount.NONE
, meaning we don't wait on any active shards. Set this value toActiveShardCount.ALL
to wait for all shards (primary and all replicas) to be active across all indices in the cluster. Otherwise, useActiveShardCount.from(int)
to set this value to any non-negative integer, up to the total number of shard copies to wait for. -
waitForActiveShards
A shortcut forwaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.from(int)
to get the ActiveShardCount. -
waitForNodes
public java.lang.String waitForNodes() -
waitForNodes
Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range. -
waitForEvents
-
waitForEvents
-
level
Set the level of detail for the health information to be returned. Only used by the high-level REST Client. -
level
Get the level of detail for the health information to be returned. Only used by the high-level REST Client. -
validate
- Specified by:
validate
in classActionRequest
-