Package org.elasticsearch.client.indices

Class CloseIndexRequest

java.lang.Object
org.elasticsearch.client.TimedRequest
org.elasticsearch.client.indices.CloseIndexRequest
All Implemented Interfaces:
Validatable
public class CloseIndexRequest extends TimedRequest implements Validatable
A request to close an index.

  • Field Details

    • DEFAULT_INDICES_OPTIONS

      public static final org.elasticsearch.action.support.IndicesOptions DEFAULT_INDICES_OPTIONS

  • Constructor Details

    • CloseIndexRequest

      public CloseIndexRequest(String... indices)
      Creates a new close index request
      Parameters:
      indices - the indices to close

  • Method Details

    • indices

      public String[] indices()
      Returns the indices to close

    • indicesOptions

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

    • indicesOptions

      public CloseIndexRequest indicesOptions(org.elasticsearch.action.support.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

    • waitForActiveShards

      public org.elasticsearch.action.support.ActiveShardCount waitForActiveShards()
      Returns the wait for active shard count or null if the default should be used

    • waitForActiveShards

      public CloseIndexRequest waitForActiveShards(org.elasticsearch.action.support.ActiveShardCount waitForActiveShards)
      Sets the number of shard copies that should be active before a close-index request returns. Defaults to null, which means not to wait. However the default behaviour is deprecated and will change in version 8. You can opt-in to the new default behaviour now by setting this to ActiveShardCount.DEFAULT, which will wait according to the setting index.write.wait_for_active_shards which by default will wait for one shard, the primary. 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. To explicitly preserve today's default behaviour and suppress the deprecation warning, set this property to ActiveShardCount.from(0).
      Parameters:
      waitForActiveShards - number of active shard copies to wait on

    • validate

      public Optional<ValidationException> validate()
      Description copied from interface: Validatable
      Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Specified by:
      validate in interface Validatable
      Returns:
      An Optional ValidationException that contains a list of validation errors.