org.elasticsearch.search.query

Class QuerySearchResult

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.search.query.QuerySearchResultProvider

org.elasticsearch.search.query.QuerySearchResult

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, SearchPhaseResult

public class QuerySearchResult
extends QuerySearchResultProvider

Nested Class Summary

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

TransportResponse.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
QuerySearchResult()
QuerySearchResult(long id, SearchShardTarget shardTarget)

Method Summary

Methods

Modifier and Type	Method and Description
Aggregations	aggregations()
void	aggregations(InternalAggregations aggregations)
int	from()
QuerySearchResult	from(int from)
long	id()
boolean	includeFetch() If both query and fetch happened on the same call.
List<SiblingPipelineAggregator>	pipelineAggregators()
void	pipelineAggregators(List<SiblingPipelineAggregator> pipelineAggregators)
List<ProfileShardResult>	profileResults() Returns the profiled results for this search, or potentially null if result was empty
void	profileResults(List<ProfileShardResult> shardResults) Sets the finalized profiling results for this query
QuerySearchResult	queryResult()
void	readFrom(StreamInput in)
void	readFromWithId(long id, StreamInput in)
static QuerySearchResult	readQuerySearchResult(StreamInput in)
boolean	searchTimedOut()
void	searchTimedOut(boolean searchTimedOut)
SearchShardTarget	shardTarget()
void	shardTarget(SearchShardTarget shardTarget)
int	size()
QuerySearchResult	size(int size)
Suggest	suggest()
void	suggest(Suggest suggest)
Boolean	terminatedEarly()
void	terminatedEarly(boolean terminatedEarly)
org.apache.lucene.search.TopDocs	topDocs()
void	topDocs(org.apache.lucene.search.TopDocs topDocs)
void	writeTo(StreamOutput out)
void	writeToNoId(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

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

Constructor Detail

QuerySearchResult

public QuerySearchResult()

QuerySearchResult

public QuerySearchResult(long id,
                 SearchShardTarget shardTarget)

Method Detail

includeFetch

public boolean includeFetch()

Description copied from class: QuerySearchResultProvider

If both query and fetch happened on the same call.

Specified by:

includeFetch in class QuerySearchResultProvider

queryResult

public QuerySearchResult queryResult()

Specified by:

queryResult in class QuerySearchResultProvider

id

public long id()

shardTarget

public SearchShardTarget shardTarget()

shardTarget

public void shardTarget(SearchShardTarget shardTarget)

searchTimedOut

public void searchTimedOut(boolean searchTimedOut)

searchTimedOut

public boolean searchTimedOut()

terminatedEarly

public void terminatedEarly(boolean terminatedEarly)

terminatedEarly

public Boolean terminatedEarly()

topDocs

public org.apache.lucene.search.TopDocs topDocs()

topDocs

public void topDocs(org.apache.lucene.search.TopDocs topDocs)

aggregations

public Aggregations aggregations()

aggregations

public void aggregations(InternalAggregations aggregations)

profileResults

@Nullable
public List<ProfileShardResult> profileResults()

Returns the profiled results for this search, or potentially null if result was empty

Returns:

The profiled results, or null

profileResults

public void profileResults(List<ProfileShardResult> shardResults)

Sets the finalized profiling results for this query

Parameters:

shardResults - The finalized profile

pipelineAggregators

public List<SiblingPipelineAggregator> pipelineAggregators()

pipelineAggregators

public void pipelineAggregators(List<SiblingPipelineAggregator> pipelineAggregators)

suggest

public Suggest suggest()

suggest

public void suggest(Suggest suggest)

from

public int from()

from

public QuerySearchResult from(int from)

size

public int size()

size

public QuerySearchResult size(int size)

readQuerySearchResult

public static QuerySearchResult readQuerySearchResult(StreamInput in)
                                               throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class TransportMessage<TransportResponse>

Throws:

IOException

readFromWithId

public void readFromWithId(long id,
                  StreamInput in)
                    throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class TransportMessage<TransportResponse>

Throws:

IOException

writeToNoId

public void writeToNoId(StreamOutput out)
                 throws IOException

Throws:

IOException