org.elasticsearch.search.internal

Interface ShardSearchRequest

All Superinterfaces:

HasContext, HasContextAndHeaders, HasHeaders

All Known Implementing Classes:

ShardSearchLocalRequest, ShardSearchTransportRequest

public interface ShardSearchRequest
extends HasContextAndHeaders

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.

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()
boolean	isProfile() Returns true if this shard search is being profiled or not
long	nowInMillis()
int	numberOfShards()
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()

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

Method Detail

index

String index()

shardId

int shardId()

types

String[] types()

source

BytesReference source()

source

void source(BytesReference source)

extraSource

BytesReference extraSource()

numberOfShards

int numberOfShards()

searchType

SearchType searchType()

filteringAliases

String[] filteringAliases()

nowInMillis

long nowInMillis()

template

Template template()

templateSource

BytesReference templateSource()

requestCache

Boolean requestCache()

scroll

Scroll scroll()

setProfile

void setProfile(boolean profile)

Sets if this shard search needs to be profiled or not

Parameters:

profile - True if the shard should be profiled

isProfile

boolean isProfile()

Returns true if this shard search is being profiled or not

cacheKey

BytesReference cacheKey()
                        throws IOException

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

Throws:

IOException