Package org.elasticsearch.search.query
Class QuerySearchResult
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.search.SearchPhaseResult
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
-
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()
Returnstrue
if this query result has unconsumed aggregationsboolean
hasConsumedTopDocs()
Returnstrue
iff the top docs have already been consumed.boolean
hasProfileResults()
boolean
hasSearchContext()
boolean
hasSuggestHits()
Returnstrue
if this result has any suggest score docsboolean
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 queryQuerySearchResult
queryResult()
Returns the query result iff it's included in this response otherwisenull
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
-
Constructor Details
-
QuerySearchResult
public QuerySearchResult() -
QuerySearchResult
- Throws:
java.io.IOException
-
QuerySearchResult
-
-
Method Details
-
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
Description copied from class:SearchPhaseResult
Returns the query result iff it's included in this response otherwisenull
- Overrides:
queryResult
in classSearchPhaseResult
-
searchTimedOut
public void searchTimedOut(boolean searchTimedOut) -
searchTimedOut
public boolean searchTimedOut() -
terminatedEarly
public void terminatedEarly(boolean terminatedEarly) -
terminatedEarly
public java.lang.Boolean terminatedEarly() -
topDocs
-
hasConsumedTopDocs
public boolean hasConsumedTopDocs()Returnstrue
iff the top docs have already been consumed. -
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
-
sortValueFormats
-
hasAggs
public boolean hasAggs()Returnstrue
if this query result has unconsumed aggregations -
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
-
aggregations
-
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
Sets the finalized profiling results for this query- Parameters:
shardResults
- The finalized profile
-
suggest
-
suggest
-
from
public int from() -
from
-
size
public int size()Returns the maximum size of this results top docs. -
size
-
serviceTimeEWMA
public long serviceTimeEWMA() -
serviceTimeEWMA
-
nodeQueueSize
public int nodeQueueSize() -
nodeQueueSize
-
hasSuggestHits
public boolean hasSuggestHits()Returnstrue
if this result has any suggest score docs -
hasSearchContext
public boolean hasSearchContext() -
readFromWithId
- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classSearchPhaseResult
- Throws:
java.io.IOException
-
writeToNoId
- Throws:
java.io.IOException
-
getTotalHits
public org.apache.lucene.search.TotalHits getTotalHits() -
getMaxScore
public float getMaxScore()
-