org.elasticsearch.search.internal

Class ShardSearchLocalRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.search.internal.ShardSearchLocalRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, ShardSearchRequest

public class ShardSearchLocalRequest
extends ContextAndHeaderHolder
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 : { ... }
      }
  }
 }
 

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
ShardSearchLocalRequest(ShardId shardId, int numberOfShards, SearchType searchType, BytesReference source, String[] types, Boolean requestCache)
ShardSearchLocalRequest(String[] types, long nowInMillis)
ShardSearchLocalRequest(String[] types, long nowInMillis, String[] filteringAliases)

Method Summary

Methods

Modifier and Type	Method and Description
BytesReference	cacheKey() Returns the cache key for this shard search request, based on its content
BytesReference	extraSource()
String[]	filteringAliases()
String	index()
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()
Boolean	requestCache()
Scroll	scroll()
SearchType	searchType()
void	setProfile(boolean profile) Sets if this shard search needs to be profiled or not
int	shardId()
BytesReference	source()
void	source(BytesReference source)
Template	template()
BytesReference	templateSource()
String[]	types()

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.HasContextAndHeaders

copyContextAndHeadersFrom

Methods inherited from interface org.elasticsearch.common.HasContext

contextSize, copyContextFrom, getContext, getFromContext, getFromContext, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from interface org.elasticsearch.common.HasHeaders

copyHeadersFrom, getHeader, getHeaders, hasHeader, putHeader

Constructor Detail

ShardSearchLocalRequest

public ShardSearchLocalRequest(String[] types,
                       long nowInMillis)

ShardSearchLocalRequest

public ShardSearchLocalRequest(String[] types,
                       long nowInMillis,
                       String[] filteringAliases)

ShardSearchLocalRequest

public ShardSearchLocalRequest(ShardId shardId,
                       int numberOfShards,
                       SearchType searchType,
                       BytesReference source,
                       String[] types,
                       Boolean requestCache)

Method Detail

index

public String index()

Specified by:

index in interface ShardSearchRequest

shardId

public int shardId()

Specified by:

shardId in interface ShardSearchRequest

types

public String[] types()

Specified by:

types in interface ShardSearchRequest

source

public BytesReference source()

Specified by:

source in interface ShardSearchRequest

source

public void source(BytesReference source)

Specified by:

source in interface ShardSearchRequest

extraSource

public BytesReference extraSource()

Specified by:

extraSource 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 String[] filteringAliases()

Specified by:

filteringAliases in interface ShardSearchRequest

nowInMillis

public long nowInMillis()

Specified by:

nowInMillis in interface ShardSearchRequest

template

public Template template()

Specified by:

template in interface ShardSearchRequest

templateSource

public BytesReference templateSource()

Specified by:

templateSource in interface ShardSearchRequest

requestCache

public 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 IOException

Throws:

IOException

innerWriteTo

protected void innerWriteTo(StreamOutput out,
                boolean asKey)
                     throws IOException

Throws:

IOException

cacheKey

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

IOException