org.elasticsearch.action.admin.cluster.reroute

Class ClusterRerouteRequest

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.AcknowledgedRequest<ClusterRerouteRequest>

org.elasticsearch.action.admin.cluster.reroute.ClusterRerouteRequest

All Implemented Interfaces:

AckedRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class ClusterRerouteRequest
extends AcknowledgedRequest<ClusterRerouteRequest>

Request to submit cluster reroute allocation commands

Nested Class Summary

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

TransportRequest.Empty

Field Summary

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

DEFAULT_ACK_TIMEOUT, timeout

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

Method Summary

Methods

Modifier and Type	Method and Description
ClusterRerouteRequest	add(AllocationCommand... commands) Adds allocation commands to be applied to the cluster.
boolean	dryRun() Returns the current dry run flag which allows to run the commands without actually applying them, just to get back the resulting cluster state back.
ClusterRerouteRequest	dryRun(boolean dryRun) Sets a dry run flag (defaults to false) allowing to run the commands without actually applying them to the cluster state, and getting the resulting cluster state back.
boolean	explain() Returns the current explain flag
ClusterRerouteRequest	explain(boolean explain) Sets the explain flag, which will collect information about the reroute request without executing the actions.
void	readFrom(StreamInput in)
ClusterRerouteRequest	source(BytesReference source) Sets the source for the request.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

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

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Constructor Detail

ClusterRerouteRequest

public ClusterRerouteRequest()

Method Detail

add

public ClusterRerouteRequest add(AllocationCommand... commands)

Adds allocation commands to be applied to the cluster. Note, can be empty, in which case will simply run a simple "reroute".

dryRun

public ClusterRerouteRequest dryRun(boolean dryRun)

Sets a dry run flag (defaults to false) allowing to run the commands without actually applying them to the cluster state, and getting the resulting cluster state back.

dryRun

public boolean dryRun()

Returns the current dry run flag which allows to run the commands without actually applying them, just to get back the resulting cluster state back.

explain

public ClusterRerouteRequest explain(boolean explain)

Sets the explain flag, which will collect information about the reroute request without executing the actions. Similar to dryRun, but human-readable.

explain

public boolean explain()

Returns the current explain flag

source

public ClusterRerouteRequest source(BytesReference source)
                             throws Exception

Sets the source for the request.

Throws:

Exception

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<ClusterRerouteRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<ClusterRerouteRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<ClusterRerouteRequest>

Throws:

IOException