java.lang.Object

org.elasticsearch.search.query.QuerySearchResult

All Implemented Interfaces:: Writeable

public final class QuerySearchResult
extends SearchPhaseResult

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse
TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
Field Summary

Fields inherited from class org.elasticsearch.search.SearchPhaseResult
contextId
Constructor Summary

Constructors

Constructor Description

QuerySearchResult()

QuerySearchResult(StreamInput in)

QuerySearchResult(SearchContextId id, SearchShardTarget shardTarget)

Method Summary

Modifier and Type	Method	Description
`DelayableWriteable<InternalAggregations>`	`aggregations()`
`void`	`aggregations(InternalAggregations aggregations)`
`DelayableWriteable<InternalAggregations>`	`consumeAggs()`	Returns and nulls out the aggregation for this search results.
`ProfileShardResult`	`consumeProfileResult()`	Returns and nulls out the profiled results for this search, or potentially null if result was empty.
`TopDocsAndMaxScore`	`consumeTopDocs()`	Returns and nulls out the top docs for this search results.
`int`	`from()`
`QuerySearchResult`	`from(int from)`
`float`	`getMaxScore()`
`org.apache.lucene.search.TotalHits`	`getTotalHits()`
`boolean`	`hasAggs()`	Returns `true` if this query result has unconsumed aggregations
`boolean`	`hasConsumedTopDocs()`	Returns `true` iff the top docs have already been consumed.
`boolean`	`hasProfileResults()`
`boolean`	`hasSearchContext()`
`boolean`	`hasSuggestHits()`	Returns `true` if this result has any suggest score docs
`boolean`	`isNull()`	Returns true if the result doesn't contain any useful information.
`int`	`nodeQueueSize()`
`QuerySearchResult`	`nodeQueueSize(int nodeQueueSize)`
`static QuerySearchResult`	`nullInstance()`	Returns an instance that contains no response.
`void`	`profileResults(ProfileShardResult shardResults)`	Sets the finalized profiling results for this query
`QuerySearchResult`	`queryResult()`	Returns the query result iff it's included in this response otherwise `null`
`void`	`readFromWithId(SearchContextId id, StreamInput in)`
`boolean`	`searchTimedOut()`
`void`	`searchTimedOut(boolean searchTimedOut)`
`long`	`serviceTimeEWMA()`
`QuerySearchResult`	`serviceTimeEWMA(long serviceTimeEWMA)`
`int`	`size()`	Returns the maximum size of this results top docs.
`QuerySearchResult`	`size(int size)`
`DocValueFormat[]`	`sortValueFormats()`
`Suggest`	`suggest()`
`void`	`suggest(Suggest suggest)`
`java.lang.Boolean`	`terminatedEarly()`
`void`	`terminatedEarly(boolean terminatedEarly)`
`TopDocsAndMaxScore`	`topDocs()`
`void`	`topDocs(TopDocsAndMaxScore topDocs, DocValueFormat[] sortValueFormats)`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.
`void`	`writeToNoId(StreamOutput out)`

Methods inherited from class org.elasticsearch.search.SearchPhaseResult

fetchResult, getContextId, getSearchShardTarget, getShardIndex, setSearchShardTarget, setShardIndex

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Constructor Details
- QuerySearchResult
  
  public QuerySearchResult()
- QuerySearchResult
  
  public QuerySearchResult(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- QuerySearchResult
  
  public QuerySearchResult(SearchContextId id, SearchShardTarget shardTarget)
Method Details
- nullInstance
  
  public static QuerySearchResult nullInstance()
  
  Returns an instance that contains no response.
- isNull
  
  public boolean isNull()
  
  Returns true if the result doesn't contain any useful information. It is used by the search action to avoid creating an empty response on shard request that rewrites to match_no_docs. TODO: Currently we need the concrete aggregators to build empty responses. This means that we cannot build an empty response in the coordinating node so we rely on this hack to ensure that at least one shard returns a valid empty response. We should move the ability to create empty responses to aggregation builders in order to allow building empty responses directly from the coordinating node.
- queryResult
  
  public QuerySearchResult queryResult()
  
  Description copied from class: SearchPhaseResult
  
  Returns the query result iff it's included in this response otherwise null
  
  Overrides:
  
  queryResult in class SearchPhaseResult
- searchTimedOut
  
  public void searchTimedOut(boolean searchTimedOut)
- searchTimedOut
  
  public boolean searchTimedOut()
- terminatedEarly
  
  public void terminatedEarly(boolean terminatedEarly)
- terminatedEarly
  
  public java.lang.Boolean terminatedEarly()
- topDocs
  
  public TopDocsAndMaxScore topDocs()
- hasConsumedTopDocs
  
  public boolean hasConsumedTopDocs()
  
  Returns true iff the top docs have already been consumed.
- consumeTopDocs
  
  public TopDocsAndMaxScore consumeTopDocs()
  
  Returns and nulls out the top docs for this search results. This allows to free up memory once the top docs are consumed.
  
  Throws:
  
  java.lang.IllegalStateException - if the top docs have already been consumed.
- topDocs
  
  public void topDocs(TopDocsAndMaxScore topDocs, DocValueFormat[] sortValueFormats)
- sortValueFormats
  
  public DocValueFormat[] sortValueFormats()
- hasAggs
  
  public boolean hasAggs()
  
  Returns true if this query result has unconsumed aggregations
- consumeAggs
  
  public DelayableWriteable<InternalAggregations> consumeAggs()
  
  Returns and nulls out the aggregation for this search results. This allows to free up memory once the aggregation is consumed.
  
  Throws:
  
  java.lang.IllegalStateException - if the aggregations have already been consumed.
- aggregations
  
  public void aggregations(InternalAggregations aggregations)
- aggregations
  
  public DelayableWriteable<InternalAggregations> aggregations()
- consumeProfileResult
  
  public ProfileShardResult consumeProfileResult()
  
  Returns and nulls out the profiled results for this search, or potentially null if result was empty. This allows to free up memory once the profiled result is consumed.
  
  Throws:
  
  java.lang.IllegalStateException - if the profiled result has already been consumed.
- hasProfileResults
  
  public boolean hasProfileResults()
- profileResults
  
  public void profileResults(ProfileShardResult shardResults)
  
  Sets the finalized profiling results for this query
  
  Parameters:
  
  shardResults - The finalized profile
- suggest
  
  public Suggest suggest()
- suggest
  
  public void suggest(Suggest suggest)
- from
  
  public int from()
- from
  
  public QuerySearchResult from(int from)
- size
  
  public int size()
  
  Returns the maximum size of this results top docs.
- size
  
  public QuerySearchResult size(int size)
- serviceTimeEWMA
  
  public long serviceTimeEWMA()
- serviceTimeEWMA
  
  public QuerySearchResult serviceTimeEWMA(long serviceTimeEWMA)
- nodeQueueSize
  
  public int nodeQueueSize()
- nodeQueueSize
  
  public QuerySearchResult nodeQueueSize(int nodeQueueSize)
- hasSuggestHits
  
  public boolean hasSuggestHits()
  
  Returns true if this result has any suggest score docs
- hasSearchContext
  
  public boolean hasSearchContext()
- readFromWithId
  
  public void readFromWithId(SearchContextId id, StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- writeTo
  
  public void writeTo(StreamOutput out) throws java.io.IOException
  
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Overrides:
  
  writeTo in class SearchPhaseResult
  
  Throws:
  
  java.io.IOException
- writeToNoId
  
  public void writeToNoId(StreamOutput out) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- getTotalHits
  
  public org.apache.lucene.search.TotalHits getTotalHits()
- getMaxScore
  
  public float getMaxScore()

Constructor	Description
`QuerySearchResult()`
`QuerySearchResult(StreamInput in)`
`QuerySearchResult(SearchContextId id, SearchShardTarget shardTarget)`

Class QuerySearchResult

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

Fields inherited from class org.elasticsearch.search.SearchPhaseResult

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.search.SearchPhaseResult

Methods inherited from class org.elasticsearch.transport.TransportMessage

Methods inherited from class java.lang.Object

Constructor Details

Method Details