public interface ShardSearchRequest
SearchContext
needs.
Provides a cache key based on its content that can be used to cache shard level response.Modifier and Type | Method and Description |
---|---|
BytesReference |
cacheKey()
Returns the cache key for this shard search request, based on its content
|
AliasFilter |
getAliasFilter() |
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. |
Rewriteable<Rewriteable> |
getRewriteable() |
float |
indexBoost() |
boolean |
isProfile()
Returns true if this shard search is being profiled or not
|
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.Boolean |
requestCache() |
Scroll |
scroll() |
SearchType |
searchType() |
void |
setAliasFilter(AliasFilter filter) |
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() |
ShardId shardId()
java.lang.String[] types()
SearchSourceBuilder source()
AliasFilter getAliasFilter()
void setAliasFilter(AliasFilter filter)
void source(SearchSourceBuilder source)
int numberOfShards()
SearchType searchType()
float indexBoost()
long nowInMillis()
java.lang.Boolean requestCache()
Scroll scroll()
void setProfile(boolean profile)
profile
- True if the shard should be profiledboolean isProfile()
BytesReference cacheKey() throws java.io.IOException
java.io.IOException
static QueryBuilder parseAliasFilter(CheckedFunction<byte[],QueryBuilder,java.io.IOException> filterParser, IndexMetaData metaData, java.lang.String... aliasNames)
The list of filtering aliases should be obtained by calling MetaData.filteringAliases. Returns null if no filtering is required.
java.lang.String getClusterAlias()
null
if the request if targeted to the local
cluster.Rewriteable<Rewriteable> getRewriteable()