Package org.opensearch.action.admin.indices.open

Class OpenIndexRequest

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<OpenIndexRequest>
org.opensearch.action.support.master.MasterNodeRequest<OpenIndexRequest>
org.opensearch.action.support.master.AcknowledgedRequest<OpenIndexRequest>
org.opensearch.action.admin.indices.open.OpenIndexRequest
All Implemented Interfaces:
IndicesRequest, IndicesRequest.Replaceable, AckedRequest, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest
@PublicApi(since="1.0.0") public class OpenIndexRequest extends AcknowledgedRequest<OpenIndexRequest> implements IndicesRequest.Replaceable
A request to open an index.
Opensearch.api:

  • Constructor Details

    • OpenIndexRequest

      public OpenIndexRequest(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

    • OpenIndexRequest

      public OpenIndexRequest()

    • OpenIndexRequest

      public OpenIndexRequest(String... indices)
      Constructs a new open index request for the specified index.

  • Method Details

    • validate

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

    • indices

      public String[] indices()
      The indices to be opened
      Specified by:
      indices in interface IndicesRequest
      Returns:
      the indices to be opened

    • indices

      public OpenIndexRequest indices(String... indices)
      Sets the indices to be opened
      Specified by:
      indices in interface IndicesRequest.Replaceable
      Parameters:
      indices - the indices to be opened
      Returns:
      the request itself

    • indicesOptions

      public IndicesOptions indicesOptions()
      Specifies what type of requested indices to ignore and how to deal with wildcard expressions. For example indices that don't exist.
      Specified by:
      indicesOptions in interface IndicesRequest
      Returns:
      the current behaviour when it comes to index names and wildcard indices expressions

    • indicesOptions

      public OpenIndexRequest indicesOptions(IndicesOptions indicesOptions)
      Specifies what type of requested indices to ignore and how to deal with wildcard expressions. For example indices that don't exist.
      Parameters:
      indicesOptions - the desired behaviour regarding indices to ignore and wildcard indices expressions
      Returns:
      the request itself

    • 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

    • waitForActiveShards

      public ActiveShardCount waitForActiveShards()

    • waitForActiveShards

      public OpenIndexRequest waitForActiveShards(ActiveShardCount waitForActiveShards)
      Sets the number of shard copies that should be active for indices opening to return. Defaults to ActiveShardCount.DEFAULT, which will wait for one shard copy (the primary) to become active. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active before returning. Otherwise, use ActiveShardCount.from(int) to set this value to any non-negative integer, up to the number of copies per shard (number of replicas + 1), to wait for the desired amount of shard copies to become active before returning. Indices opening will only wait up until the timeout value for the number of shard copies to be active before returning. Check ShardsAcknowledgedResponse.isShardsAcknowledged() to determine if the requisite shard copies were all started before returning or timing out.
      Parameters:
      waitForActiveShards - number of active shard copies to wait on

    • waitForActiveShards

      public OpenIndexRequest waitForActiveShards(int waitForActiveShards)
      A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

    • setShouldStoreResult

      public void setShouldStoreResult(boolean shouldStoreResult)
      Should this task store its result after it has finished?

    • getShouldStoreResult

      public boolean getShouldStoreResult()
      Description copied from class: ActionRequest
      Should this task store its result after it has finished?
      Overrides:
      getShouldStoreResult 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 AcknowledgedRequest<OpenIndexRequest>
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getDescription

      public 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