Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.search.SearchResponse

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class SearchResponse
extends ActionResponse
implements ChunkedToXContentObject

A response of a search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResponse.Cluster	Represents the search metadata about a particular cluster involved in a cross-cluster search.
static final class	SearchResponse.Clusters	Holds info about the clusters that the search was executed on: how many in total, how many of them were successful and how many of them were skipped and further details in a Map of Cluster objects (when doing a cross-cluster search).

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCAL_CLUSTER_NAME_REPRESENTATION
static final ParseField	NUM_REDUCE_PHASES
static final ParseField	POINT_IN_TIME_ID
static final ParseField	SCROLL_ID
static final ParseField	TERMINATED_EARLY
static final ParseField	TIMED_OUT
static final ParseField	TOOK

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
SearchResponse(SearchResponseSections searchResponseSections, String scrollId, int totalShards, int successfulShards, int skippedShards, long tookInMillis, ShardSearchFailure[] shardFailures, SearchResponse.Clusters clusters, String pointInTimeId)
SearchResponse(StreamInput in)
SearchResponse(SearchHits hits, InternalAggregations aggregations, Suggest suggest, boolean timedOut, Boolean terminatedEarly, SearchProfileResults profileResults, int numReducePhases, String scrollId, int totalShards, int successfulShards, int skippedShards, long tookInMillis, ShardSearchFailure[] shardFailures, SearchResponse.Clusters clusters)
SearchResponse(SearchHits hits, InternalAggregations aggregations, Suggest suggest, boolean timedOut, Boolean terminatedEarly, SearchProfileResults profileResults, int numReducePhases, String scrollId, int totalShards, int successfulShards, int skippedShards, long tookInMillis, ShardSearchFailure[] shardFailures, SearchResponse.Clusters clusters, String pointInTimeId)

Method Summary

Modifier and Type	Method	Description
boolean	decRef()	Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply.
static SearchResponse	empty(Supplier<Long> tookInMillisSupplier, SearchResponse.Clusters clusters)
InternalAggregations	getAggregations()	Aggregations in this response.
SearchResponse.Clusters	getClusters()	Returns info about what clusters the search was executed against.
int	getFailedShards()	The failed number of shards the search was executed on.
SearchHits	getHits()	The search hits.
int	getNumReducePhases()	Returns the number of reduce phases applied to obtain this search response
Map<String,SearchProfileShardResult>	getProfileResults()	If profiling was enabled, this returns an object containing the profile results from each shard.
String	getScrollId()	If scrolling was enabled (SearchRequest.scroll(org.elasticsearch.search.Scroll), the scroll id that can be used to continue scrolling.
ShardSearchFailure[]	getShardFailures()	The failures that occurred during the search.
int	getSkippedShards()	The number of shards skipped due to pre-filtering
int	getSuccessfulShards()	The successful number of shards the search was executed on.
Suggest	getSuggest()
TimeValue	getTook()	How long the search took.
long	getTookInMillis()
int	getTotalShards()	The total number of shards the search was executed on.
boolean	hasAggregations()	Will getAggregations() return non-empty aggregation results?
boolean	hasReferences()
XContentBuilder	headerToXContent(XContentBuilder builder, ToXContent.Params params)
void	incRef()
Iterator<? extends ToXContent>	innerToXContentChunked(ToXContent.Params params)
Boolean	isTerminatedEarly()	Has the search operation terminated early due to reaching terminateAfter
boolean	isTimedOut()	Has the search operation timed out.
String	pointInTimeId()	Returns the encoded string of the search context that the search request is used to executed
RestStatus	status()
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
boolean	tryIncRef()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

toXContentChunkedV7

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Field Details

LOCAL_CLUSTER_NAME_REPRESENTATION

public static final String LOCAL_CLUSTER_NAME_REPRESENTATION

See Also:

• Constant Field Values

SCROLL_ID

public static final ParseField SCROLL_ID

POINT_IN_TIME_ID

public static final ParseField POINT_IN_TIME_ID

TOOK

public static final ParseField TOOK

TIMED_OUT

public static final ParseField TIMED_OUT

TERMINATED_EARLY

public static final ParseField TERMINATED_EARLY

NUM_REDUCE_PHASES

public static final ParseField NUM_REDUCE_PHASES

Constructor Details

SearchResponse

public SearchResponse(StreamInput in)
               throws IOException

Throws:

IOException

SearchResponse

public SearchResponse(SearchHits hits,
 InternalAggregations aggregations,
 Suggest suggest,
 boolean timedOut,
 Boolean terminatedEarly,
 SearchProfileResults profileResults,
 int numReducePhases,
 String scrollId,
 int totalShards,
 int successfulShards,
 int skippedShards,
 long tookInMillis,
 ShardSearchFailure[] shardFailures,
 SearchResponse.Clusters clusters)

SearchResponse

public SearchResponse(SearchResponseSections searchResponseSections,
 String scrollId,
 int totalShards,
 int successfulShards,
 int skippedShards,
 long tookInMillis,
 ShardSearchFailure[] shardFailures,
 SearchResponse.Clusters clusters,
 String pointInTimeId)

SearchResponse

public SearchResponse(SearchHits hits,
 InternalAggregations aggregations,
 Suggest suggest,
 boolean timedOut,
 Boolean terminatedEarly,
 SearchProfileResults profileResults,
 int numReducePhases,
 String scrollId,
 int totalShards,
 int successfulShards,
 int skippedShards,
 long tookInMillis,
 ShardSearchFailure[] shardFailures,
 SearchResponse.Clusters clusters,
 String pointInTimeId)

Method Details

incRef

public void incRef()

Specified by:

incRef in interface RefCounted

Overrides:

incRef in class TransportMessage

tryIncRef

public boolean tryIncRef()

Specified by:

tryIncRef in interface RefCounted

Overrides:

tryIncRef in class TransportMessage

decRef

public boolean decRef()

Description copied from class: TransportMessage

Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply. When in doubt, dispatch any further work onto a separate thread.

Specified by:

decRef in interface RefCounted

Overrides:

decRef in class TransportMessage

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface RefCounted

Overrides:

hasReferences in class TransportMessage

status

public RestStatus status()

getHits

public SearchHits getHits()

The search hits.

getAggregations

@Nullable
public InternalAggregations getAggregations()

Aggregations in this response. "empty" aggregations could be either null or InternalAggregations.EMPTY.

hasAggregations

public boolean hasAggregations()

Will getAggregations() return non-empty aggregation results?

getSuggest

public Suggest getSuggest()

isTimedOut

public boolean isTimedOut()

Has the search operation timed out.

isTerminatedEarly

public Boolean isTerminatedEarly()

Has the search operation terminated early due to reaching terminateAfter

getNumReducePhases

public int getNumReducePhases()

Returns the number of reduce phases applied to obtain this search response

getTook

public TimeValue getTook()

How long the search took.

getTookInMillis

public long getTookInMillis()

getTotalShards

public int getTotalShards()

The total number of shards the search was executed on.

getSuccessfulShards

public int getSuccessfulShards()

The successful number of shards the search was executed on.

getSkippedShards

public int getSkippedShards()

The number of shards skipped due to pre-filtering

getFailedShards

public int getFailedShards()

The failed number of shards the search was executed on.

getShardFailures

public ShardSearchFailure[] getShardFailures()

The failures that occurred during the search.

getScrollId

public String getScrollId()

If scrolling was enabled (SearchRequest.scroll(org.elasticsearch.search.Scroll), the scroll id that can be used to continue scrolling.

pointInTimeId

public String pointInTimeId()

Returns the encoded string of the search context that the search request is used to executed

getProfileResults

@Nullable
public Map<String,SearchProfileShardResult> getProfileResults()

If profiling was enabled, this returns an object containing the profile results from each shard. If profiling was not enabled, this will return null

Returns:

The profile results or an empty map

getClusters

public SearchResponse.Clusters getClusters()

Returns info about what clusters the search was executed against. Available only in responses obtained from a Cross Cluster Search request, otherwise null

See Also:

• SearchResponse.Clusters

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

innerToXContentChunked

public Iterator<? extends ToXContent> innerToXContentChunked(ToXContent.Params params)

headerToXContent

public XContentBuilder headerToXContent(XContentBuilder builder,
 ToXContent.Params params)
                                 throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

empty

public static SearchResponse empty(Supplier<Long> tookInMillisSupplier,
 SearchResponse.Clusters clusters)