Class ShardSearchLocalRequest
- java.lang.Object
-
- org.elasticsearch.search.internal.ShardSearchLocalRequest
-
- All Implemented Interfaces:
ShardSearchRequest
public class ShardSearchLocalRequest extends java.lang.Object implements ShardSearchRequest
Shard level search request that gets created and consumed on the local node. Used by warmers and by api that need to create a search context within their execution. Source structure:{ from : 0, size : 20, (optional, can be set on the request) sort : { "name.first" : {}, "name.last" : { reverse : true } } fields : [ "name.first", "name.last" ] query : { ... } aggs : { "agg1" : { terms : { ... } } } }
-
-
Constructor Summary
Constructors Constructor Description ShardSearchLocalRequest(ShardId shardId, int numberOfShards, SearchType searchType, SearchSourceBuilder source, java.lang.String[] types, java.lang.Boolean requestCache, AliasFilter aliasFilter, float indexBoost, boolean allowPartialSearchResults, java.lang.String[] indexRoutings, java.lang.String preference)ShardSearchLocalRequest(ShardId shardId, java.lang.String[] types, long nowInMillis, AliasFilter aliasFilter)
-
Method Summary
Modifier and Type Method Description java.lang.BooleanallowPartialSearchResults()BytesReferencecacheKey()Returns the cache key for this shard search request, based on its contentAliasFiltergetAliasFilter()java.lang.StringgetClusterAlias()Returns the cluster alias in case the request is part of a cross-cluster search request,nullotherwise.Rewriteable<Rewriteable>getRewriteable()floatindexBoost()java.lang.String[]indexRoutings()Returns the routing values resolved by the coordinating node for the index pointed byShardSearchRequest.shardId().protected voidinnerReadFrom(StreamInput in)protected voidinnerWriteTo(StreamOutput out, boolean asKey)booleanisProfile()Returns true if this shard search is being profiled or notlongnowInMillis()intnumberOfShards()java.lang.Stringpreference()Returns the preference of the originalSearchRequest.preference().java.lang.BooleanrequestCache()Scrollscroll()SearchTypesearchType()voidsetAliasFilter(AliasFilter aliasFilter)voidsetProfile(boolean profile)Sets if this shard search needs to be profiled or notShardIdshardId()SearchSourceBuildersource()voidsource(SearchSourceBuilder source)java.lang.String[]types()
-
-
-
Constructor Detail
-
ShardSearchLocalRequest
public ShardSearchLocalRequest(ShardId shardId, java.lang.String[] types, long nowInMillis, AliasFilter aliasFilter)
-
ShardSearchLocalRequest
public ShardSearchLocalRequest(ShardId shardId, int numberOfShards, SearchType searchType, SearchSourceBuilder source, java.lang.String[] types, java.lang.Boolean requestCache, AliasFilter aliasFilter, float indexBoost, boolean allowPartialSearchResults, java.lang.String[] indexRoutings, java.lang.String preference)
-
-
Method Detail
-
shardId
public ShardId shardId()
- Specified by:
shardIdin interfaceShardSearchRequest
-
types
public java.lang.String[] types()
- Specified by:
typesin interfaceShardSearchRequest
-
source
public SearchSourceBuilder source()
- Specified by:
sourcein interfaceShardSearchRequest
-
getAliasFilter
public AliasFilter getAliasFilter()
- Specified by:
getAliasFilterin interfaceShardSearchRequest
-
setAliasFilter
public void setAliasFilter(AliasFilter aliasFilter)
- Specified by:
setAliasFilterin interfaceShardSearchRequest
-
source
public void source(SearchSourceBuilder source)
- Specified by:
sourcein interfaceShardSearchRequest
-
numberOfShards
public int numberOfShards()
- Specified by:
numberOfShardsin interfaceShardSearchRequest
-
searchType
public SearchType searchType()
- Specified by:
searchTypein interfaceShardSearchRequest
-
indexBoost
public float indexBoost()
- Specified by:
indexBoostin interfaceShardSearchRequest
-
nowInMillis
public long nowInMillis()
- Specified by:
nowInMillisin interfaceShardSearchRequest
-
requestCache
public java.lang.Boolean requestCache()
- Specified by:
requestCachein interfaceShardSearchRequest
-
allowPartialSearchResults
public java.lang.Boolean allowPartialSearchResults()
- Specified by:
allowPartialSearchResultsin interfaceShardSearchRequest
-
scroll
public Scroll scroll()
- Specified by:
scrollin interfaceShardSearchRequest
-
indexRoutings
public java.lang.String[] indexRoutings()
Description copied from interface:ShardSearchRequestReturns the routing values resolved by the coordinating node for the index pointed byShardSearchRequest.shardId().- Specified by:
indexRoutingsin interfaceShardSearchRequest
-
preference
public java.lang.String preference()
Description copied from interface:ShardSearchRequestReturns the preference of the originalSearchRequest.preference().- Specified by:
preferencein interfaceShardSearchRequest
-
setProfile
public void setProfile(boolean profile)
Description copied from interface:ShardSearchRequestSets if this shard search needs to be profiled or not- Specified by:
setProfilein interfaceShardSearchRequest- Parameters:
profile- True if the shard should be profiled
-
isProfile
public boolean isProfile()
Description copied from interface:ShardSearchRequestReturns true if this shard search is being profiled or not- Specified by:
isProfilein interfaceShardSearchRequest
-
innerReadFrom
protected void innerReadFrom(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
innerWriteTo
protected void innerWriteTo(StreamOutput out, boolean asKey) throws java.io.IOException
- Throws:
java.io.IOException
-
cacheKey
public BytesReference cacheKey() throws java.io.IOException
Description copied from interface:ShardSearchRequestReturns the cache key for this shard search request, based on its content- Specified by:
cacheKeyin interfaceShardSearchRequest- Throws:
java.io.IOException
-
getClusterAlias
public java.lang.String getClusterAlias()
Description copied from interface:ShardSearchRequestReturns the cluster alias in case the request is part of a cross-cluster search request,nullotherwise.- Specified by:
getClusterAliasin interfaceShardSearchRequest
-
getRewriteable
public Rewriteable<Rewriteable> getRewriteable()
- Specified by:
getRewriteablein interfaceShardSearchRequest
-
-