Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.state

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, 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 final 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, String type, String action, TaskId parentTaskId, Map<String,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)
String	getDescription()	Returns optional description of the request to be displayed by the task manager
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
ClusterStateRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
final ClusterStateRequest	indicesOptions(IndicesOptions indicesOptions)
boolean	metadata()
ClusterStateRequest	metadata(boolean metadata)
boolean	nodes()
ClusterStateRequest	nodes(boolean nodes)
boolean	routingTable()
ClusterStateRequest	routingTable(boolean routingTable)
ActionRequestValidationException	validate()
Long	waitForMetadataVersion()
ClusterStateRequest	waitForMetadataVersion(long waitForMetadataVersion)
TimeValue	waitForTimeout()
ClusterStateRequest	waitForTimeout(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, hasReferences, 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.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Field Details

DEFAULT_WAIT_FOR_NODE_TIMEOUT

public static final TimeValue DEFAULT_WAIT_FOR_NODE_TIMEOUT

Constructor Details

ClusterStateRequest

public ClusterStateRequest()

ClusterStateRequest

public ClusterStateRequest(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

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 MasterNodeReadRequest<ClusterStateRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

all

public ClusterStateRequest all()

clear

public ClusterStateRequest clear()

routingTable

public boolean routingTable()

routingTable

public ClusterStateRequest routingTable(boolean routingTable)

nodes

public boolean nodes()

nodes

public ClusterStateRequest nodes(boolean nodes)

metadata

public boolean metadata()

metadata

public ClusterStateRequest metadata(boolean metadata)

blocks

public boolean blocks()

blocks

public ClusterStateRequest blocks(boolean blocks)

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indices

public ClusterStateRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions 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 interface IndicesRequest

indicesOptions

public final ClusterStateRequest indicesOptions(IndicesOptions indicesOptions)

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.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 interface IndicesRequest

customs

public ClusterStateRequest customs(boolean customs)

customs

public boolean customs()

waitForTimeout

public TimeValue waitForTimeout()

waitForTimeout

public ClusterStateRequest waitForTimeout(TimeValue waitForTimeout)

waitForMetadataVersion

public Long waitForMetadataVersion()

waitForMetadataVersion

public ClusterStateRequest waitForMetadataVersion(long waitForMetadataVersion)

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,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 interface TaskAwareRequest

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest