Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchShardsRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.search.SearchShardsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest

public final class SearchShardsRequest
extends ActionRequest
implements IndicesRequest.Replaceable

A request to find the list of target shards that might match the query for the given target indices.

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.RemoteClusterShardRequest, 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 interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
SearchShardsRequest(String[] indices, IndicesOptions indicesOptions, QueryBuilder query, String routing, String preference, boolean allowPartialSearchResults, String clusterAlias)
SearchShardsRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	allowPartialSearchResults()
String	clusterAlias()
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	equals(Object o)
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
IndicesRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
String	preference()
QueryBuilder	query()
String	routing()
String	toString()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, getRequestId, setParentTask, setRequestId

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

getDescription, setParentTask

Constructor Details

SearchShardsRequest

public SearchShardsRequest(String[] indices,
 IndicesOptions indicesOptions,
 QueryBuilder query,
 String routing,
 String preference,
 boolean allowPartialSearchResults,
 String clusterAlias)

SearchShardsRequest

public SearchShardsRequest(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 ActionRequest

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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

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

indices

public IndicesRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

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

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

clusterAlias

public String clusterAlias()

query

public QueryBuilder query()

routing

public String routing()

preference

public String preference()

allowPartialSearchResults

public boolean allowPartialSearchResults()

toString

public String toString()

Overrides:

toString in class TransportRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object