org.elasticsearch.action.admin.cluster.health

Class ClusterHealthRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

org.elasticsearch.action.support.master.MasterNodeRequest<T>

org.elasticsearch.action.support.master.MasterNodeReadRequest<ClusterHealthRequest>

org.elasticsearch.action.admin.cluster.health.ClusterHealthRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

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

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

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

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
ClusterHealthRequest()
ClusterHealthRequest(String... indices)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	indices() Returns the array of indices that the action relates to
ClusterHealthRequest	indices(String[] indices)
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
void	readFrom(StreamInput in)
TimeValue	timeout()
ClusterHealthRequest	timeout(String timeout)
ClusterHealthRequest	timeout(TimeValue timeout)
ActionRequestValidationException	validate()
int	waitForActiveShards()
ClusterHealthRequest	waitForActiveShards(int waitForActiveShards)
Priority	waitForEvents()
ClusterHealthRequest	waitForEvents(Priority waitForEvents)
ClusterHealthRequest	waitForGreenStatus()
String	waitForNodes()
ClusterHealthRequest	waitForNodes(String waitForNodes) Waits for N number of nodes.
int	waitForRelocatingShards()
ClusterHealthRequest	waitForRelocatingShards(int waitForRelocatingShards)
ClusterHealthStatus	waitForStatus()
ClusterHealthRequest	waitForStatus(ClusterHealthStatus waitForStatus)
ClusterHealthRequest	waitForYellowStatus()
void	writeTo(StreamOutput out)

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.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterHealthRequest

public ClusterHealthRequest()

ClusterHealthRequest

public ClusterHealthRequest(String... indices)

Method Detail

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)

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

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()

waitForRelocatingShards

public int waitForRelocatingShards()

waitForRelocatingShards

public ClusterHealthRequest waitForRelocatingShards(int waitForRelocatingShards)

waitForActiveShards

public int waitForActiveShards()

waitForActiveShards

public ClusterHealthRequest waitForActiveShards(int waitForActiveShards)

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()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<ClusterHealthRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeReadRequest<ClusterHealthRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeReadRequest<ClusterHealthRequest>

Throws:

IOException