org.elasticsearch.action.admin.cluster.shards

Class ClusterSearchShardsRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

org.elasticsearch.action.support.master.MasterNodeRequest<T>

org.elasticsearch.action.support.master.MasterNodeReadRequest<ClusterSearchShardsRequest>

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

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

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

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
ClusterSearchShardsRequest()
ClusterSearchShardsRequest(String... indices)

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	readFrom(StreamInput in)
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.
ClusterSearchShardsRequest	routing(String routing) A comma separated list of routing values to control the shards the search will be executed on.
String[]	types() The document types to execute the search against.
ClusterSearchShardsRequest	types(String... types) The document types to execute the search against.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClusterSearchShardsRequest

public ClusterSearchShardsRequest()

ClusterSearchShardsRequest

public ClusterSearchShardsRequest(String... indices)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<ClusterSearchShardsRequest>

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)

types

public String[] types()

The document types to execute the search against. Defaults to be executed against all types.

types

public ClusterSearchShardsRequest types(String... types)

The document types to execute the search against. Defaults to be executed against all types.

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, _primary to execute only on primary shards, or a custom value, which guarantees that the same order will be used across different requests.

preference

public String preference()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeReadRequest<ClusterSearchShardsRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeReadRequest<ClusterSearchShardsRequest>

Throws:

IOException