Module org.elasticsearch.server
Class ClusterStateRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.local.LocalClusterStateRequest
org.elasticsearch.action.admin.cluster.state.ClusterStateRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest,TransportRequest
public class ClusterStateRequest
extends LocalClusterStateRequest
implements IndicesRequest.Replaceable
A local-only request for obtaining (parts of) the cluster state.
RemoteClusterStateRequest can be used for obtaining cluster
states from remote clusters.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionall()booleanblocks()blocks(boolean blocks) clear()Returns the task object that should be used to keep track of the processing of the request.booleancustoms()customs(boolean customs) Returns optional description of the request to be displayed by the task managerbooleanDetermines whether the request should be applied to data streams.String[]indices()Returns the array of indices that the action relates toSets the indices that the action relates to.Returns the indices options used to resolve indices.final ClusterStateRequestindicesOptions(IndicesOptions indicesOptions) booleanmetadata()metadata(boolean metadata) booleannodes()nodes(boolean nodes) booleanroutingTable(boolean routingTable) validate()waitForMetadataVersion(long waitForMetadataVersion) waitForTimeout(TimeValue waitForTimeout) Methods inherited from class org.elasticsearch.action.support.local.LocalClusterStateRequest
masterTimeout, writeToMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, setParentTask
-
Field Details
-
DEFAULT_WAIT_FOR_NODE_TIMEOUT
-
-
Constructor Details
-
ClusterStateRequest
-
-
Method Details
-
validate
- Overrides:
validatein classLocalClusterStateRequest
-
all
-
clear
-
routingTable
public boolean routingTable() -
routingTable
-
nodes
public boolean nodes() -
nodes
-
metadata
public boolean metadata() -
metadata
-
blocks
public boolean blocks() -
blocks
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
indices
Description copied from interface:IndicesRequest.ReplaceableSets the indices that the action relates to.- Specified by:
indicesin interfaceIndicesRequest.Replaceable
-
indicesOptions
Description copied from interface:IndicesRequestReturns 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:
indicesOptionsin interfaceIndicesRequest
-
indicesOptions
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequestDetermines 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:
includeDataStreamsin interfaceIndicesRequest
-
customs
-
customs
public boolean customs() -
waitForTimeout
-
waitForTimeout
-
waitForMetadataVersion
-
waitForMetadataVersion
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequestReturns the task object that should be used to keep track of the processing of the request.- Specified by:
createTaskin interfaceTaskAwareRequest
-
getDescription
Description copied from interface:TaskAwareRequestReturns optional description of the request to be displayed by the task manager- Specified by:
getDescriptionin interfaceTaskAwareRequest
-