Package org.elasticsearch.action.admin.indices.open

Class OpenIndexRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<OpenIndexRequest>

org.elasticsearch.action.admin.indices.open.OpenIndexRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, AckedRequest, Writeable, TaskAwareRequest

public class OpenIndexRequest
extends AcknowledgedRequest<OpenIndexRequest>
implements IndicesRequest.Replaceable

A request to open an index.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
OpenIndexRequest()
OpenIndexRequest(String... indices)	Constructs a new open index request for the specified index.
OpenIndexRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String[]	indices()	The indices to be opened
OpenIndexRequest	indices(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.
ActionRequestValidationException	validate()
ActiveShardCount	waitForActiveShards()
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.
OpenIndexRequest	waitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that should be active for indices opening to return.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, timeout, timeout, timeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Detail

OpenIndexRequest

public OpenIndexRequest(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 Detail

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

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.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<OpenIndexRequest>

Throws:

IOException