public class OpenIndexRequest extends AcknowledgedRequest<OpenIndexRequest> implements IndicesRequest.Replaceable
TransportRequest.Empty
IndicesRequest.Replaceable
DEFAULT_ACK_TIMEOUT, timeout
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
Constructor and Description |
---|
OpenIndexRequest() |
OpenIndexRequest(java.lang.String... indices)
Constructs a new open index request for the specified index.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
indices()
The indices to be opened
|
OpenIndexRequest |
indices(java.lang.String... indices)
Sets the indices to be opened
|
IndicesOptions |
indicesOptions()
Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
|
OpenIndexRequest |
indicesOptions(IndicesOptions indicesOptions)
Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
|
void |
readFrom(StreamInput in)
Set this object's fields from a StreamInput.
|
ActionRequestValidationException |
validate() |
ActiveShardCount |
waitForActiveShards() |
OpenIndexRequest |
waitForActiveShards(ActiveShardCount waitForActiveShards)
Sets the number of shard copies that should be active for indices opening to return.
|
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. |
void |
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.
|
ackTimeout, timeout, timeout, timeout
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
getShouldStoreResult
getParentTask, setParentTask
remoteAddress, remoteAddress
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
masterNodeTimeout
createTask, getDescription, setParentTask
public OpenIndexRequest()
public OpenIndexRequest(java.lang.String... indices)
public ActionRequestValidationException validate()
validate
in class ActionRequest
public java.lang.String[] indices()
indices
in interface IndicesRequest
public OpenIndexRequest indices(java.lang.String... indices)
indices
in interface IndicesRequest.Replaceable
indices
- the indices to be openedpublic IndicesOptions indicesOptions()
indicesOptions
in interface IndicesRequest
public OpenIndexRequest indicesOptions(IndicesOptions indicesOptions)
indicesOptions
- the desired behaviour regarding indices to ignore and wildcard indices expressionspublic ActiveShardCount waitForActiveShards()
public OpenIndexRequest waitForActiveShards(ActiveShardCount waitForActiveShards)
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 OpenIndexResponse.isShardsAcknowledged()
to
determine if the requisite shard copies were all started before returning or timing out.waitForActiveShards
- number of active shard copies to wait onpublic OpenIndexRequest waitForActiveShards(int waitForActiveShards)
waitForActiveShards(ActiveShardCount)
where the numerical
shard count is passed in, instead of having to first call ActiveShardCount.from(int)
to get the ActiveShardCount.public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class AcknowledgedRequest<OpenIndexRequest>
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class AcknowledgedRequest<OpenIndexRequest>
java.io.IOException