Package org.elasticsearch.search.internal

Class ShardSearchRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.search.internal.ShardSearchRequest

All Implemented Interfaces:

IndicesRequest, Writeable, TaskAwareRequest

public class ShardSearchRequest
extends TransportRequest
implements IndicesRequest

Shard level request that represents a search. It provides all the methods that the SearchContext needs. Provides a cache key based on its content that can be used to cache shard level response.

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>

Constructor Summary

Constructors

Constructor	Description
ShardSearchRequest(OriginalIndices originalIndices, SearchRequest searchRequest, ShardId shardId, int numberOfShards, AliasFilter aliasFilter, float indexBoost, long nowInMillis, java.lang.String clusterAlias, java.lang.String[] indexRoutings)
ShardSearchRequest(StreamInput in)
ShardSearchRequest(ShardId shardId, java.lang.String[] types, long nowInMillis, AliasFilter aliasFilter)

Method Summary

Modifier and Type	Method	Description
boolean	allowPartialSearchResults()
BytesReference	cacheKey()	Returns the cache key for this shard search request, based on its content
Task	createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)	Returns the task object that should be used to keep track of the processing of the request.
AliasFilter	getAliasFilter()
java.lang.String	getClusterAlias()
java.lang.String	getDescription()	Returns optional description of the request to be displayed by the task manager
Rewriteable<Rewriteable>	getRewriteable()
float	indexBoost()
java.lang.String[]	indexRoutings()
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
protected void	innerWriteTo(StreamOutput out, boolean asKey)
long	nowInMillis()
int	numberOfShards()
static QueryBuilder	parseAliasFilter(CheckedFunction<byte[],QueryBuilder,java.io.IOException> filterParser, IndexMetaData metaData, java.lang.String... aliasNames)	Returns the filter associated with listed filtering aliases.
java.lang.String	preference()
java.lang.Boolean	requestCache()
Scroll	scroll()
SearchType	searchType()
void	setAliasFilter(AliasFilter aliasFilter)
ShardId	shardId()
SearchSourceBuilder	source()
void	source(SearchSourceBuilder source)
java.lang.String[]	types()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Constructor Detail

ShardSearchRequest

public ShardSearchRequest(OriginalIndices originalIndices,
                          SearchRequest searchRequest,
                          ShardId shardId,
                          int numberOfShards,
                          AliasFilter aliasFilter,
                          float indexBoost,
                          long nowInMillis,
                          @Nullable
                          java.lang.String clusterAlias,
                          java.lang.String[] indexRoutings)

ShardSearchRequest

public ShardSearchRequest(ShardId shardId,
                          java.lang.String[] types,
                          long nowInMillis,
                          AliasFilter aliasFilter)

ShardSearchRequest

public ShardSearchRequest(StreamInput in)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class TransportRequest

Throws:

java.io.IOException

innerWriteTo

protected final void innerWriteTo(StreamOutput out,
                                  boolean asKey)
                           throws java.io.IOException

Throws:

java.io.IOException

indices

public java.lang.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

shardId

public ShardId shardId()

types

public java.lang.String[] types()

source

public SearchSourceBuilder source()

getAliasFilter

public AliasFilter getAliasFilter()

setAliasFilter

public void setAliasFilter(AliasFilter aliasFilter)

source

public void source(SearchSourceBuilder source)

numberOfShards

public int numberOfShards()

searchType

public SearchType searchType()

indexBoost

public float indexBoost()

nowInMillis

public long nowInMillis()

requestCache

public java.lang.Boolean requestCache()

allowPartialSearchResults

public boolean allowPartialSearchResults()

scroll

public Scroll scroll()

indexRoutings

public java.lang.String[] indexRoutings()

preference

public java.lang.String preference()

cacheKey

public BytesReference cacheKey()
                        throws java.io.IOException

Returns the cache key for this shard search request, based on its content

Throws:

java.io.IOException

getClusterAlias

public java.lang.String getClusterAlias()

createTask

public Task createTask(long id,
                       java.lang.String type,
                       java.lang.String action,
                       TaskId parentTaskId,
                       java.util.Map<java.lang.String,java.lang.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 java.lang.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

getRewriteable

public Rewriteable<Rewriteable> getRewriteable()

parseAliasFilter

public static QueryBuilder parseAliasFilter(CheckedFunction<byte[],QueryBuilder,java.io.IOException> filterParser,
                                            IndexMetaData metaData,
                                            java.lang.String... aliasNames)

Returns the filter associated with listed filtering aliases.

The list of filtering aliases should be obtained by calling MetaData.filteringAliases. Returns null if no filtering is required.