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 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 and Description
ShardSearchLocalRequest(ShardId shardId, int numberOfShards, SearchType searchType, SearchSourceBuilder source, java.lang.String[] types, java.lang.Boolean requestCache, AliasFilter aliasFilter, float indexBoost)
ShardSearchLocalRequest(ShardId shardId, java.lang.String[] types, long nowInMillis, AliasFilter aliasFilter)

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()
protected void	innerReadFrom(StreamInput in)
protected void	innerWriteTo(StreamOutput out, boolean asKey)
boolean	isProfile() Returns true if this shard search is being profiled or not
long	nowInMillis()
int	numberOfShards()
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()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.internal.ShardSearchRequest

parseAliasFilter

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)

Method Detail

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

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

filteringAliases

public QueryBuilder filteringAliases()

Specified by:

filteringAliases 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

scroll

public Scroll scroll()

Specified by:

scroll in interface ShardSearchRequest

setProfile

public void setProfile(boolean profile)

Description copied from interface: ShardSearchRequest

Sets if this shard search needs to be profiled or not

Specified by:

setProfile in interface ShardSearchRequest

Parameters:

profile - True if the shard should be profiled

isProfile

public boolean isProfile()

Description copied from interface: ShardSearchRequest

Returns true if this shard search is being profiled or not

Specified by:

isProfile in interface ShardSearchRequest

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: ShardSearchRequest

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

Specified by:

cacheKey in interface ShardSearchRequest

Throws:

java.io.IOException

rewrite

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

Description copied from interface: ShardSearchRequest

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

Specified by:

rewrite in interface ShardSearchRequest

Throws:

java.io.IOException

getClusterAlias

public java.lang.String getClusterAlias()

Description copied from interface: ShardSearchRequest

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

Specified by:

getClusterAlias in interface ShardSearchRequest