Package org.elasticsearch.search.internal

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 directly 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(SearchRequest searchRequest, ShardId shardId, int numberOfShards, AliasFilter aliasFilter, float indexBoost, long nowInMillis, java.lang.String clusterAlias, java.lang.String[] indexRoutings)
ShardSearchLocalRequest(ShardId shardId, java.lang.String[] types, long nowInMillis, AliasFilter aliasFilter)

Method Summary

Modifier and Type	Method	Description
boolean	allowPartialSearchResults()
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 in case the request is part of a cross-cluster search request, null otherwise.
Rewriteable<Rewriteable>	getRewriteable()
float	indexBoost()
java.lang.String[]	indexRoutings()	Returns the routing values resolved by the coordinating node for the index pointed by ShardSearchRequest.shardId().
protected void	innerWriteTo(StreamOutput out, boolean asKey)
long	nowInMillis()
int	numberOfShards()
java.lang.String	preference()	Returns the preference of the original SearchRequest.preference().
java.lang.Boolean	requestCache()
Scroll	scroll()
SearchType	searchType()
void	setAliasFilter(AliasFilter aliasFilter)
ShardId	shardId()
SearchSourceBuilder	source()
void	source(SearchSourceBuilder source)
java.lang.String[]	types()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShardSearchLocalRequest

public ShardSearchLocalRequest(SearchRequest searchRequest,
                               ShardId shardId,
                               int numberOfShards,
                               AliasFilter aliasFilter,
                               float indexBoost,
                               long nowInMillis,
                               @Nullable
                               java.lang.String clusterAlias,
                               java.lang.String[] indexRoutings)

ShardSearchLocalRequest

public ShardSearchLocalRequest(ShardId shardId,
                               java.lang.String[] types,
                               long nowInMillis,
                               AliasFilter aliasFilter)

Method Detail

innerWriteTo

protected final void innerWriteTo(StreamOutput out,
                                  boolean asKey)
                           throws java.io.IOException

Throws:

java.io.IOException

shardId

public ShardId shardId()

Specified by:

shardId in interface ShardSearchRequest

types

public java.lang.String[] types()

Specified by:

types in interface ShardSearchRequest

source

public SearchSourceBuilder source()

Specified by:

source in interface ShardSearchRequest

getAliasFilter

public AliasFilter getAliasFilter()

Specified by:

getAliasFilter in interface ShardSearchRequest

setAliasFilter

public void setAliasFilter(AliasFilter aliasFilter)

Specified by:

setAliasFilter in interface ShardSearchRequest

source

public void source(SearchSourceBuilder source)

Specified by:

source in interface ShardSearchRequest

numberOfShards

public int numberOfShards()

Specified by:

numberOfShards in interface ShardSearchRequest

searchType

public SearchType searchType()

Specified by:

searchType in interface ShardSearchRequest

indexBoost

public float indexBoost()

Specified by:

indexBoost in interface ShardSearchRequest

nowInMillis

public long nowInMillis()

Specified by:

nowInMillis in interface ShardSearchRequest

requestCache

public java.lang.Boolean requestCache()

Specified by:

requestCache in interface ShardSearchRequest

allowPartialSearchResults

public boolean allowPartialSearchResults()

Specified by:

allowPartialSearchResults in interface ShardSearchRequest

scroll

public Scroll scroll()

Specified by:

scroll in interface ShardSearchRequest

indexRoutings

public java.lang.String[] indexRoutings()

Description copied from interface: ShardSearchRequest

Returns the routing values resolved by the coordinating node for the index pointed by ShardSearchRequest.shardId().

Specified by:

indexRoutings in interface ShardSearchRequest

preference

public java.lang.String preference()

Description copied from interface: ShardSearchRequest

Returns the preference of the original SearchRequest.preference().

Specified by:

preference in interface ShardSearchRequest

cacheKey

public BytesReference cacheKey()
                        throws java.io.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:

java.io.IOException

getClusterAlias

public java.lang.String getClusterAlias()

Description copied from interface: ShardSearchRequest

Returns the cluster alias in case the request is part of a cross-cluster search request, null otherwise.

Specified by:

getClusterAlias in interface ShardSearchRequest

getRewriteable

public Rewriteable<Rewriteable> getRewriteable()

Specified by:

getRewriteable in interface ShardSearchRequest