org.elasticsearch.action.search

Class SearchResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.search.SearchResponse

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, StatusToXContent, ToXContent

public class SearchResponse
extends ActionResponse
implements StatusToXContent

A response of a search request.

Nested Class Summary

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

TransportResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SearchResponse()
SearchResponse(InternalSearchResponse internalResponse, String scrollId, int totalShards, int successfulShards, long tookInMillis, ShardSearchFailure[] shardFailures)

Method Summary

Modifier and Type	Method and Description
Aggregations	getAggregations()
int	getFailedShards() The failed number of shards the search was executed on.
SearchHits	getHits() The search hits.
Map<String,List<ProfileShardResult>>	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	getSuccessfulShards() The successful number of shards the search was executed on.
Suggest	getSuggest()
TimeValue	getTook() How long the search took.
long	getTookInMillis() How long the search took in milliseconds.
int	getTotalShards() The total number of shards the search was executed on.
Boolean	isTerminatedEarly() Has the search operation terminated early due to reaching terminateAfter
boolean	isTimedOut() Has the search operation timed out.
void	readFrom(StreamInput in)
void	scrollId(String scrollId)
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)

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, wait, wait, wait

Constructor Detail

SearchResponse

public SearchResponse()

SearchResponse

public SearchResponse(InternalSearchResponse internalResponse,
                      String scrollId,
                      int totalShards,
                      int successfulShards,
                      long tookInMillis,
                      ShardSearchFailure[] shardFailures)

Method Detail

status

public RestStatus status()

Description copied from interface: StatusToXContent

Returns the REST status to make sure it is returned correctly

Specified by:

status in interface StatusToXContent

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

getTook

public TimeValue getTook()

How long the search took.

getTookInMillis

public long getTookInMillis()

How long the search took in milliseconds.

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.

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.

scrollId

public void scrollId(String scrollId)

getProfileResults

@Nullable
public Map<String,List<ProfileShardResult>> 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 null

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object