Package org.elasticsearch.action.admin.cluster.shards

Class ClusterSearchShardsRequest

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<ClusterSearchShardsRequest>

org.elasticsearch.action.admin.cluster.shards.ClusterSearchShardsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class ClusterSearchShardsRequest
extends MasterNodeReadRequest<ClusterSearchShardsRequest>
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 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
ClusterSearchShardsRequest()
ClusterSearchShardsRequest(String... indices)
ClusterSearchShardsRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	The indices
ClusterSearchShardsRequest	indices(String... indices)	Sets the indices the search will be executed on.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
ClusterSearchShardsRequest	indicesOptions(IndicesOptions indicesOptions)
String	preference()
ClusterSearchShardsRequest	preference(String preference)	Sets the preference to execute the search.
String	routing()	A comma separated list of routing values to control the shards the search will be executed on.
ClusterSearchShardsRequest	routing(String routing)	A comma separated list of routing values to control the shards the search will be executed on.
ClusterSearchShardsRequest	routing(String... routings)	The routing values to control the shards that the search will be executed on.
ActionRequestValidationException	validate()
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

createTask, getDescription, setParentTask

Constructor Details

ClusterSearchShardsRequest

public ClusterSearchShardsRequest()

ClusterSearchShardsRequest

public ClusterSearchShardsRequest(String... indices)

ClusterSearchShardsRequest

public ClusterSearchShardsRequest(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<ClusterSearchShardsRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indices

public ClusterSearchShardsRequest indices(String... indices)

Sets the indices the search will be executed on.

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public String[] indices()

The indices

Specified by:

indices in interface IndicesRequest

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 ClusterSearchShardsRequest 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

routing

public String routing()

A comma separated list of routing values to control the shards the search will be executed on.

routing

public ClusterSearchShardsRequest routing(String routing)

A comma separated list of routing values to control the shards the search will be executed on.

routing

public ClusterSearchShardsRequest routing(String... routings)

The routing values to control the shards that the search will be executed on.

preference

public ClusterSearchShardsRequest preference(String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards or a custom value, which guarantees that the same order will be used across different requests.

preference

public String preference()