Package org.elasticsearch.action.admin.cluster.health

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, RefCounted, TaskAwareRequest

public class ClusterHealthRequest
extends MasterNodeReadRequest<ClusterHealthRequest>
implements IndicesRequest.Replaceable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	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.MasterNodeReadRequest

local

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
ClusterHealthRequest()
ClusterHealthRequest(String... indices)
ClusterHealthRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
ClusterHealthRequest	indices(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(String timeout)
ClusterHealthRequest	timeout(TimeValue timeout)
ActionRequestValidationException	validate()
ActiveShardCount	waitForActiveShards()
ClusterHealthRequest	waitForActiveShards(int waitForActiveShards)	A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.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()
String	waitForNodes()
ClusterHealthRequest	waitForNodes(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.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

ClusterHealthRequest

public ClusterHealthRequest()

ClusterHealthRequest

public ClusterHealthRequest(String... indices)

ClusterHealthRequest

public ClusterHealthRequest(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeReadRequest<ClusterHealthRequest>

Throws:

IOException

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indices

public ClusterHealthRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions 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 interface IndicesRequest

indicesOptions

public ClusterHealthRequest indicesOptions(IndicesOptions indicesOptions)

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

timeout

public TimeValue timeout()

timeout

public ClusterHealthRequest timeout(TimeValue timeout)

timeout

public ClusterHealthRequest timeout(String timeout)

waitForStatus

public ClusterHealthStatus waitForStatus()

waitForStatus

public ClusterHealthRequest waitForStatus(ClusterHealthStatus waitForStatus)

waitForGreenStatus

public ClusterHealthRequest waitForGreenStatus()

waitForYellowStatus

public ClusterHealthRequest waitForYellowStatus()

waitForNoRelocatingShards

public boolean waitForNoRelocatingShards()

waitForNoRelocatingShards

public ClusterHealthRequest waitForNoRelocatingShards(boolean waitForNoRelocatingShards)

Sets whether the request should wait for there to be no relocating shards before retrieving the cluster health status. Defaults to false, meaning the operation does not wait on there being no more relocating shards. Set to true to wait until the number of relocating shards in the cluster is 0.

waitForNoInitializingShards

public boolean waitForNoInitializingShards()

waitForNoInitializingShards

public ClusterHealthRequest waitForNoInitializingShards(boolean waitForNoInitializingShards)

Sets whether the request should wait for there to be no initializing shards before retrieving the cluster health status. Defaults to false, meaning the operation does not wait on there being no more initializing shards. Set to true to wait until the number of initializing shards in the cluster is 0.

waitForActiveShards

public ActiveShardCount waitForActiveShards()

waitForActiveShards

public ClusterHealthRequest waitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that must be active across all indices before getting the health status. Defaults to ActiveShardCount.NONE, meaning we don't wait on any active shards. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active across all indices in the cluster. Otherwise, use ActiveShardCount.from(int) to set this value to any non-negative integer, up to the total number of shard copies to wait for.

waitForActiveShards

public ClusterHealthRequest waitForActiveShards(int waitForActiveShards)

A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

waitForNodes

public String waitForNodes()

waitForNodes

public ClusterHealthRequest waitForNodes(String waitForNodes)

Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range.

waitForEvents

public ClusterHealthRequest waitForEvents(Priority waitForEvents)

waitForEvents

public Priority waitForEvents()

level

public void level(ClusterHealthRequest.Level level)

Set the level of detail for the health information to be returned. Only used by the high-level REST Client.

level

public ClusterHealthRequest.Level level()

Get the level of detail for the health information to be returned. Only used by the high-level REST Client.

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest