org.elasticsearch.search.internal

Interface ShardSearchRequest

All Known Implementing Classes:

ShardSearchLocalRequest, ShardSearchTransportRequest

public interface ShardSearchRequest

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

Modifier and Type	Method and Description
BytesReference	cacheKey() Returns the cache key for this shard search request, based on its content
QueryBuilder	filteringAliases()
java.lang.String	getClusterAlias() Returns the cluster alias if this request is for a remote cluster or null if the request if targeted to the local cluster.
float	indexBoost()
boolean	isProfile() Returns true if this shard search is being profiled or not
long	nowInMillis()
int	numberOfShards()
static QueryBuilder	parseAliasFilter(CheckedFunction<byte[],java.util.Optional<QueryBuilder>,java.io.IOException> filterParser, IndexMetaData metaData, java.lang.String... aliasNames) Returns the filter associated with listed filtering aliases.
java.lang.Boolean	requestCache()
void	rewrite(QueryShardContext context) Rewrites this request into its primitive form.
Scroll	scroll()
SearchType	searchType()
void	setProfile(boolean profile) Sets if this shard search needs to be profiled or not
ShardId	shardId()
SearchSourceBuilder	source()
void	source(SearchSourceBuilder source)
java.lang.String[]	types()

Method Detail

shardId

ShardId shardId()

types

java.lang.String[] types()

source

SearchSourceBuilder source()

source

void source(SearchSourceBuilder source)

numberOfShards

int numberOfShards()

searchType

SearchType searchType()

filteringAliases

QueryBuilder filteringAliases()

indexBoost

float indexBoost()

nowInMillis

long nowInMillis()

requestCache

java.lang.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 java.io.IOException

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

Throws:

java.io.IOException

rewrite

void rewrite(QueryShardContext context)
      throws java.io.IOException

Rewrites this request into its primitive form. e.g. by rewriting the QueryBuilder.

Throws:

java.io.IOException

parseAliasFilter

static QueryBuilder parseAliasFilter(CheckedFunction<byte[],java.util.Optional<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.

getClusterAlias

java.lang.String getClusterAlias()

Returns the cluster alias if this request is for a remote cluster or null if the request if targeted to the local cluster.