Package org.elasticsearch.client.indices
Class FreezeIndexRequest
java.lang.Object
org.elasticsearch.client.TimedRequest
org.elasticsearch.client.indices.FreezeIndexRequest
- All Implemented Interfaces:
Validatable
Request for the _freeze index API
-
Field Summary
Fields inherited from class org.elasticsearch.client.TimedRequest
DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the indices to freezeReturns the wait for active shard count or null if the default should be usedSpecifies what type of requested indices to ignore and how to deal with wildcard expressions.void
setIndicesOptions
(IndicesOptions indicesOptions) Specifies what type of requested indices to ignore and how to deal with wildcard expressions.void
setWaitForActiveShards
(ActiveShardCount waitForActiveShards) Sets the number of shard copies that should be active for indices opening to return.Methods inherited from class org.elasticsearch.client.TimedRequest
masterNodeTimeout, setMasterTimeout, setTimeout, timeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Constructor Details
-
FreezeIndexRequest
Creates a new freeze index request- Parameters:
indices
- the index to freeze
-
-
Method Details
-
getIndices
Returns the indices to freeze -
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
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
Returns the wait for active shard count or null if the default should be used -
setWaitForActiveShards
Sets the number of shard copies that should be active for indices opening to return. Defaults toActiveShardCount.DEFAULT
, which will wait for one shard copy (the primary) to become active. Set this value toActiveShardCount.ALL
to wait for all shards (primary and all replicas) to be active before returning. Otherwise, useActiveShardCount.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. CheckShardsAcknowledgedResponse.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
-