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, StatusToXContentObject, RefCounted, ToXContent, ToXContentObject

public class SearchResponse
extends ActionResponse
implements StatusToXContentObject

A response of a search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static 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.

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

ActionResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchResponse(SearchResponseSections internalResponse, String scrollId, int totalShards, int successfulShards, int skippedShards, long tookInMillis, ShardSearchFailure[] shardFailures, SearchResponse.Clusters clusters)
SearchResponse(SearchResponseSections internalResponse, String scrollId, int totalShards, int successfulShards, int skippedShards, long tookInMillis, ShardSearchFailure[] shardFailures, SearchResponse.Clusters clusters, String pointInTimeId)
SearchResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static SearchResponse	fromXContent(XContentParser parser)
Aggregations	getAggregations()
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.
SearchResponseSections	getInternalResponse()
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.
int	getTotalShards()	The total number of shards the search was executed on.
static SearchResponse	innerFromXContent(XContentParser parser)
XContentBuilder	innerToXContent(XContentBuilder builder, 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()	Returns the REST status to make sure it is returned correctly
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

SearchResponse

public SearchResponse(StreamInput in)
               throws IOException

Throws:

IOException

SearchResponse

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

SearchResponse

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

Method Details

status

public RestStatus status()

Description copied from interface: StatusToXContentObject

Returns the REST status to make sure it is returned correctly

Specified by:

status in interface StatusToXContentObject

getInternalResponse

public SearchResponseSections getInternalResponse()

getHits

public SearchHits getHits()

The search hits.

getAggregations

public Aggregations getAggregations()

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.

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

innerToXContent

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

Throws:

IOException

fromXContent

public static SearchResponse fromXContent(XContentParser parser)
                                   throws IOException

Throws:

IOException

innerFromXContent

public static SearchResponse innerFromXContent(XContentParser parser)
                                        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