Class ClearVotingConfigExclusionsRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<ClearVotingConfigExclusionsRequest>
org.elasticsearch.action.admin.cluster.configuration.ClearVotingConfigExclusionsRequest
- All Implemented Interfaces:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
public class ClearVotingConfigExclusionsRequest
extends MasterNodeRequest<ClearVotingConfigExclusionsRequest>
A request to clear the voting config exclusions from the cluster state, optionally waiting for these nodes to be removed from the
cluster first.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
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
ConstructorDescriptionConstruct a request to remove all the voting config exclusions from the cluster state. -
Method Summary
Modifier and TypeMethodDescriptionorg.elasticsearch.core.TimeValue
boolean
void
setTimeout(org.elasticsearch.core.TimeValue timeout)
void
setWaitForRemoval(boolean waitForRemoval)
toString()
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.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
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, 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.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
ClearVotingConfigExclusionsRequest
public ClearVotingConfigExclusionsRequest()Construct a request to remove all the voting config exclusions from the cluster state. -
ClearVotingConfigExclusionsRequest
- Throws:
IOException
-
-
Method Details
-
getWaitForRemoval
public boolean getWaitForRemoval()- Returns:
- whether to wait for the currently excluded nodes to be removed from the cluster before removing their exclusions. True by default.
-
setWaitForRemoval
public void setWaitForRemoval(boolean waitForRemoval)- Parameters:
waitForRemoval
- whether to wait for the currently excluded nodes to be removed from the cluster before removing their exclusions. True by default.
-
setTimeout
public void setTimeout(org.elasticsearch.core.TimeValue timeout)- Parameters:
timeout
- how long to wait for the excluded nodes to be removed ifwaitForRemoval
is true. Defaults to 30 seconds.
-
getTimeout
public org.elasticsearch.core.TimeValue getTimeout()- Returns:
- how long to wait for the excluded nodes to be removed if
waitForRemoval
is true. Defaults to 30 seconds.
-
validate
- Specified by:
validate
in classActionRequest
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeRequest<ClearVotingConfigExclusionsRequest>
- Throws:
IOException
-
toString
- Overrides:
toString
in classTransportRequest
-