Package org.elasticsearch.action.admin.cluster.state

Class ClusterStateRequest

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<ClusterStateRequest>
org.elasticsearch.action.admin.cluster.state.ClusterStateRequest
All Implemented Interfaces:
IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.common.util.concurrent.RefCounted, TaskAwareRequest
public class ClusterStateRequest
extends MasterNodeReadRequest<ClusterStateRequest>
implements IndicesRequest.Replaceable

  • Field Details

    • DEFAULT_WAIT_FOR_NODE_TIMEOUT

      public static final org.elasticsearch.common.unit.TimeValue DEFAULT_WAIT_FOR_NODE_TIMEOUT

  • Constructor Details

    • ClusterStateRequest

      public ClusterStateRequest()

    • ClusterStateRequest

      public ClusterStateRequest​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Overrides:
      writeTo in class MasterNodeReadRequest<ClusterStateRequest>
      Throws:
      java.io.IOException

    • validate

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

    • all

      public ClusterStateRequest all()

    • clear

      public ClusterStateRequest clear()

    • routingTable

      public boolean routingTable()

    • routingTable

      public ClusterStateRequest routingTable​(boolean routingTable)

    • nodes

      public boolean nodes()

    • nodes

      public ClusterStateRequest nodes​(boolean nodes)

    • metadata

      public boolean metadata()

    • metadata

      public ClusterStateRequest metadata​(boolean metadata)

    • blocks

      public boolean blocks()

    • blocks

      public ClusterStateRequest blocks​(boolean blocks)

    • indices

      public java.lang.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 ClusterStateRequest indices​(java.lang.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 final ClusterStateRequest 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

    • customs

      public ClusterStateRequest customs​(boolean customs)

    • customs

      public boolean customs()

    • waitForTimeout

      public org.elasticsearch.common.unit.TimeValue waitForTimeout()

    • waitForTimeout

      public ClusterStateRequest waitForTimeout​(org.elasticsearch.common.unit.TimeValue waitForTimeout)

    • waitForMetadataVersion

      public java.lang.Long waitForMetadataVersion()

    • waitForMetadataVersion

      public ClusterStateRequest waitForMetadataVersion​(long waitForMetadataVersion)

    • createTask

      public Task createTask​(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,​java.lang.String> headers)
      Description copied from interface: TaskAwareRequest
      Returns the task object that should be used to keep track of the processing of the request.
      Specified by:
      createTask in interface TaskAwareRequest

    • getDescription

      public java.lang.String getDescription()
      Description copied from interface: TaskAwareRequest
      Returns optional description of the request to be displayed by the task manager
      Specified by:
      getDescription in interface TaskAwareRequest