Package org.opensearch.action.admin.cluster.configuration

Class ClearVotingConfigExclusionsRequest

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<ClearVotingConfigExclusionsRequest>
org.opensearch.action.admin.cluster.configuration.ClearVotingConfigExclusionsRequest
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest
public class ClearVotingConfigExclusionsRequest extends ClusterManagerNodeRequest<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.
Opensearch.internal:

  • Constructor Details

    • ClearVotingConfigExclusionsRequest

      public ClearVotingConfigExclusionsRequest()
      Construct a request to remove all the voting config exclusions from the cluster state.

    • ClearVotingConfigExclusionsRequest

      public ClearVotingConfigExclusionsRequest(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      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.opensearch.common.unit.TimeValue timeout)
      Parameters:
      timeout - how long to wait for the excluded nodes to be removed if waitForRemoval is true. Defaults to 30 seconds.

    • getTimeout

      public org.opensearch.common.unit.TimeValue getTimeout()
      Returns:
      how long to wait for the excluded nodes to be removed if waitForRemoval is true. Defaults to 30 seconds.

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Overrides:
      writeTo in class ClusterManagerNodeRequest<ClearVotingConfigExclusionsRequest>
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object