Class ClusterStateRequest
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.MasterNodeReadRequest<ClusterStateRequest>
org.elasticsearch.action.admin.cluster.state.ClusterStateRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,org.elasticsearch.common.util.concurrent.RefCounted
,TaskAwareRequest
public class ClusterStateRequest extends MasterNodeReadRequest<ClusterStateRequest> implements IndicesRequest.Replaceable
-
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 Modifier and Type Field Description static org.elasticsearch.common.unit.TimeValue
DEFAULT_WAIT_FOR_NODE_TIMEOUT
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
-
Constructor Summary
Constructors Constructor Description ClusterStateRequest()
ClusterStateRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description ClusterStateRequest
all()
boolean
blocks()
ClusterStateRequest
blocks(boolean blocks)
ClusterStateRequest
clear()
Task
createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)
Returns the task object that should be used to keep track of the processing of the request.boolean
customs()
ClusterStateRequest
customs(boolean customs)
java.lang.String
getDescription()
Returns optional description of the request to be displayed by the task managerboolean
includeDataStreams()
Determines whether the request should be applied to data streams.java.lang.String[]
indices()
Returns the array of indices that the action relates toClusterStateRequest
indices(java.lang.String... indices)
Sets the indices that the action relates to.IndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.ClusterStateRequest
indicesOptions(IndicesOptions indicesOptions)
boolean
metadata()
ClusterStateRequest
metadata(boolean metadata)
boolean
nodes()
ClusterStateRequest
nodes(boolean nodes)
boolean
routingTable()
ClusterStateRequest
routingTable(boolean routingTable)
ActionRequestValidationException
validate()
java.lang.Long
waitForMetadataVersion()
ClusterStateRequest
waitForMetadataVersion(long waitForMetadataVersion)
org.elasticsearch.common.unit.TimeValue
waitForTimeout()
ClusterStateRequest
waitForTimeout(org.elasticsearch.common.unit.TimeValue waitForTimeout)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local, local
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, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
setParentTask
-
Field Details
-
DEFAULT_WAIT_FOR_NODE_TIMEOUT
public static final org.elasticsearch.common.unit.TimeValue DEFAULT_WAIT_FOR_NODE_TIMEOUT
-
-
Constructor Details
-
ClusterStateRequest
public ClusterStateRequest() -
ClusterStateRequest
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeReadRequest<ClusterStateRequest>
- Throws:
java.io.IOException
-
validate
- Specified by:
validate
in classActionRequest
-
all
-
clear
-
routingTable
public boolean routingTable() -
routingTable
-
nodes
public boolean nodes() -
nodes
-
metadata
public boolean metadata() -
metadata
-
blocks
public boolean blocks() -
blocks
-
indices
public java.lang.String[] indices()Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
indices
Description copied from interface:IndicesRequest.Replaceable
Sets the indices that the action relates to.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
indicesOptions
Description copied from interface:IndicesRequest
Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.- Specified by:
indicesOptions
in interfaceIndicesRequest
-
indicesOptions
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequest
Determines whether the request should be applied to data streams. Whenfalse
, none of the names or wildcard expressions inIndicesRequest.indices()
should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.- Specified by:
includeDataStreams
in interfaceIndicesRequest
-
customs
-
customs
public boolean customs() -
waitForTimeout
public org.elasticsearch.common.unit.TimeValue waitForTimeout() -
waitForTimeout
-
waitForMetadataVersion
public java.lang.Long waitForMetadataVersion() -
waitForMetadataVersion
-
createTask
public Task createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)Description copied from interface:TaskAwareRequest
Returns the task object that should be used to keep track of the processing of the request.- Specified by:
createTask
in interfaceTaskAwareRequest
-
getDescription
public java.lang.String getDescription()Description copied from interface:TaskAwareRequest
Returns optional description of the request to be displayed by the task manager- Specified by:
getDescription
in interfaceTaskAwareRequest
-