org.elasticsearch.search.internal

Class InternalSearchResponse

java.lang.Object

org.elasticsearch.search.internal.InternalSearchResponse

All Implemented Interfaces:

Streamable, ToXContent

public class InternalSearchResponse
extends Object
implements Streamable, ToXContent

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalSearchResponse(InternalSearchHits hits, InternalAggregations aggregations, Suggest suggest, InternalProfileShardResults profileResults, boolean timedOut, Boolean terminatedEarly)

Method Summary

Modifier and Type	Method and Description
Aggregations	aggregations()
static InternalSearchResponse	empty()
SearchHits	hits()
Map<String,List<ProfileShardResult>>	profile() Returns the profile results for this search response (including all shards).
void	readFrom(StreamInput in)
static InternalSearchResponse	readInternalSearchResponse(StreamInput in)
Suggest	suggest()
Boolean	terminatedEarly()
boolean	timedOut()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalSearchResponse

public InternalSearchResponse(InternalSearchHits hits,
                              InternalAggregations aggregations,
                              Suggest suggest,
                              InternalProfileShardResults profileResults,
                              boolean timedOut,
                              Boolean terminatedEarly)

Method Detail

empty

public static InternalSearchResponse empty()

timedOut

public boolean timedOut()

terminatedEarly

public Boolean terminatedEarly()

hits

public SearchHits hits()

aggregations

public Aggregations aggregations()

suggest

public Suggest suggest()

profile

public Map<String,List<ProfileShardResult>> profile()

Returns the profile results for this search response (including all shards). An empty map is returned if profiling was not enabled

Returns:

Profile results

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readInternalSearchResponse

public static InternalSearchResponse readInternalSearchResponse(StreamInput in)
                                                         throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException