Package org.elasticsearch.client.indices

Class FreezeIndexRequest

  • All Implemented Interfaces:
    Validatable
    public final class FreezeIndexRequest
extends TimedRequest
    Request for the _freeze index API

    • Constructor Detail

      • FreezeIndexRequest

        public FreezeIndexRequest​(java.lang.String... indices)
        Creates a new freeze index request
        Parameters:
        indices - the index to freeze

    • Method Detail

      • getIndices

        public java.lang.String[] getIndices()
        Returns the indices to freeze

      • 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.
        Returns:
        the current behaviour when it comes to index names and wildcard indices expressions

      • setIndicesOptions

        public void setIndicesOptions​(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

      • getWaitForActiveShards

        public ActiveShardCount getWaitForActiveShards()
        Returns the wait for active shard cound or null if the default should be used

      • setWaitForActiveShards

        public void setWaitForActiveShards​(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