Class CloseIndexRequest
- 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<CloseIndexRequest>
-
- org.elasticsearch.action.admin.indices.close.CloseIndexRequest
-
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,AckedRequest
,Writeable
,TaskAwareRequest
public class CloseIndexRequest extends AcknowledgedRequest<CloseIndexRequest> implements IndicesRequest.Replaceable
A request to close 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 CloseIndexRequest()
CloseIndexRequest(java.lang.String... indices)
Constructs a new close index request for the specified index.CloseIndexRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String[]
indices()
The indices to be closedCloseIndexRequest
indices(java.lang.String... indices)
Sets the indices to be closedIndicesOptions
indicesOptions()
Specifies what type of requested indices to ignore and how to deal with wildcard expressions.CloseIndexRequest
indicesOptions(IndicesOptions indicesOptions)
Specifies what type of requested indices to ignore and how to deal wild wildcard expressions.ActionRequestValidationException
validate()
ActiveShardCount
waitForActiveShards()
CloseIndexRequest
waitForActiveShards(ActiveShardCount waitForActiveShards)
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
-
CloseIndexRequest
public CloseIndexRequest(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
CloseIndexRequest
public CloseIndexRequest()
-
CloseIndexRequest
public CloseIndexRequest(java.lang.String... indices)
Constructs a new close index request for the specified index.
-
-
Method Detail
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
indices
public java.lang.String[] indices()
The indices to be closed- Specified by:
indices
in interfaceIndicesRequest
- Returns:
- the indices to be closed
-
indices
public CloseIndexRequest indices(java.lang.String... indices)
Sets the indices to be closed- Specified by:
indices
in interfaceIndicesRequest.Replaceable
- Parameters:
indices
- the indices to be closed- 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 interfaceIndicesRequest
- Returns:
- the desired behaviour regarding indices to ignore and wildcard indices expressions
-
indicesOptions
public CloseIndexRequest indicesOptions(IndicesOptions indicesOptions)
Specifies what type of requested indices to ignore and how to deal wild 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 CloseIndexRequest waitForActiveShards(ActiveShardCount waitForActiveShards)
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classAcknowledgedRequest<CloseIndexRequest>
- Throws:
java.io.IOException
-
-