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
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 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
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionSearchShardsRequest(String[] indices, IndicesOptions indicesOptions, QueryBuilder query, String routing, String preference, boolean allowPartialSearchResults, String clusterAlias) -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the task object that should be used to keep track of the processing of the request.booleaninthashCode()booleanDetermines 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.query()routing()toString()validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods 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
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classActionRequest- Throws:
IOException
-
validate
- Specified by:
validatein classActionRequest
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
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
-
indices
Description copied from interface:IndicesRequest.ReplaceableSets the indices that the action relates to.- Specified by:
indicesin interfaceIndicesRequest.Replaceable
-
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
-
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
-
clusterAlias
-
query
-
routing
-
preference
-
allowPartialSearchResults
public boolean allowPartialSearchResults() -
toString
- Overrides:
toStringin classTransportRequest
-
equals
-
hashCode
public int hashCode()
-