org.elasticsearch.search.internal

Class ShardSearchTransportRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.search.internal.ShardSearchTransportRequest

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable, ShardSearchRequest

public class ShardSearchTransportRequest
extends TransportRequest
implements ShardSearchRequest, IndicesRequest

Shard level search request that represents an actual search sent from the coordinating node to the nodes holding the shards where the query needs to be executed. Holds the same info as ShardSearchLocalRequest but gets sent over the transport and holds also the indices coming from the original request that generated it, plus its headers and context.

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.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
ShardSearchTransportRequest()
ShardSearchTransportRequest(SearchRequest searchRequest, ShardRouting shardRouting, int numberOfShards, String[] filteringAliases, long nowInMillis)

Method Summary

Methods

Modifier and Type	Method and Description
BytesReference	cacheKey() Returns the cache key for this shard search request, based on its content
BytesReference	extraSource()
String[]	filteringAliases()
String	index()
String[]	indices() Returns the array of indices that the action relates to
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
boolean	isProfile() Returns true if this shard search is being profiled or not
long	nowInMillis()
int	numberOfShards()
void	readFrom(StreamInput in)
Boolean	requestCache()
Scroll	scroll()
SearchType	searchType()
void	setProfile(boolean profile) Sets if this shard search needs to be profiled or not
int	shardId()
BytesReference	source()
void	source(BytesReference source)
Template	template()
BytesReference	templateSource()
String[]	types()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, 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

Methods inherited from interface org.elasticsearch.common.HasContextAndHeaders

copyContextAndHeadersFrom

Methods inherited from interface org.elasticsearch.common.HasContext

contextSize, copyContextFrom, getContext, getFromContext, getFromContext, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from interface org.elasticsearch.common.HasHeaders

copyHeadersFrom, getHeader, getHeaders, hasHeader, putHeader

Constructor Detail

ShardSearchTransportRequest

public ShardSearchTransportRequest()

ShardSearchTransportRequest

public ShardSearchTransportRequest(SearchRequest searchRequest,
                           ShardRouting shardRouting,
                           int numberOfShards,
                           String[] filteringAliases,
                           long nowInMillis)

Method Detail

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

index

public String index()

Specified by:

index in interface ShardSearchRequest

shardId

public int shardId()

Specified by:

shardId in interface ShardSearchRequest

types

public String[] types()

Specified by:

types in interface ShardSearchRequest

source

public BytesReference source()

Specified by:

source in interface ShardSearchRequest

source

public void source(BytesReference source)

Specified by:

source in interface ShardSearchRequest

extraSource

public BytesReference extraSource()

Specified by:

extraSource in interface ShardSearchRequest

numberOfShards

public int numberOfShards()

Specified by:

numberOfShards in interface ShardSearchRequest

searchType

public SearchType searchType()

Specified by:

searchType in interface ShardSearchRequest

filteringAliases

public String[] filteringAliases()

Specified by:

filteringAliases in interface ShardSearchRequest

nowInMillis

public long nowInMillis()

Specified by:

nowInMillis in interface ShardSearchRequest

template

public Template template()

Specified by:

template in interface ShardSearchRequest

templateSource

public BytesReference templateSource()

Specified by:

templateSource in interface ShardSearchRequest

requestCache

public Boolean requestCache()

Specified by:

requestCache in interface ShardSearchRequest

scroll

public Scroll scroll()

Specified by:

scroll in interface ShardSearchRequest

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class TransportMessage<TransportRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class TransportMessage<TransportRequest>

Throws:

IOException

cacheKey

public BytesReference cacheKey()
                        throws IOException

Description copied from interface: ShardSearchRequest

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

Specified by:

cacheKey in interface ShardSearchRequest

Throws:

IOException

setProfile

public void setProfile(boolean profile)

Description copied from interface: ShardSearchRequest

Sets if this shard search needs to be profiled or not

Specified by:

setProfile in interface ShardSearchRequest

Parameters:

profile - True if the shard should be profiled

isProfile

public boolean isProfile()

Description copied from interface: ShardSearchRequest

Returns true if this shard search is being profiled or not

Specified by:

isProfile in interface ShardSearchRequest