Class IndicesShardStoresRequest

All Implemented Interfaces:
IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.common.util.concurrent.RefCounted, TaskAwareRequest

public class IndicesShardStoresRequest
extends MasterNodeReadRequest<IndicesShardStoresRequest>
implements IndicesRequest.Replaceable
  • Constructor Details

    • IndicesShardStoresRequest

      public IndicesShardStoresRequest​(java.lang.String... indices)
      Create a request for shard stores info for indices
    • IndicesShardStoresRequest

      public IndicesShardStoresRequest()
    • IndicesShardStoresRequest

      public IndicesShardStoresRequest​(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<IndicesShardStoresRequest>
      Throws:
      java.io.IOException
    • shardStatuses

      public IndicesShardStoresRequest shardStatuses​(java.lang.String... shardStatuses)
      Set statuses to filter shards to get stores info on. see ClusterHealthStatus for details. Defaults to "yellow" and "red" status
      Parameters:
      shardStatuses - acceptable values are "green", "yellow", "red" and "all"
    • indicesOptions

      public IndicesShardStoresRequest indicesOptions​(IndicesOptions indicesOptions)
      Specifies what type of requested indices to ignore and wildcard indices expressions By default, expands wildcards to both open and closed indices
    • indices

      public IndicesShardStoresRequest indices​(java.lang.String... indices)
      Sets the indices for the shard stores request
      Specified by:
      indices in interface IndicesRequest.Replaceable
    • 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
    • shardStatuses

      public java.util.EnumSet<ClusterHealthStatus> shardStatuses()
      Returns the shard criteria to get store information on
    • 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
    • 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
    • validate

      Specified by:
      validate in class ActionRequest