Package org.opensearch.search.internal

Class InternalSearchResponse

java.lang.Object

org.opensearch.action.search.SearchResponseSections

org.opensearch.search.internal.InternalSearchResponse

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class InternalSearchResponse
extends SearchResponseSections
implements Writeable, org.opensearch.common.xcontent.ToXContentFragment

SearchResponseSections subclass that can be serialized over the wire.

Nested Class Summary

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

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields inherited from class org.opensearch.action.search.SearchResponseSections

aggregations, hits, numReducePhases, profileResults, suggest, terminatedEarly, timedOut

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalSearchResponse(StreamInput in)
InternalSearchResponse(SearchHits hits, InternalAggregations aggregations, Suggest suggest, SearchProfileShardResults profileResults, boolean timedOut, java.lang.Boolean terminatedEarly, int numReducePhases)

Method Summary

Modifier and Type	Method	Description
static InternalSearchResponse	empty()
static InternalSearchResponse	empty(boolean withTotalHits)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.search.SearchResponseSections

aggregations, getNumReducePhases, hits, profile, suggest, terminatedEarly, timedOut, toXContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalSearchResponse

public InternalSearchResponse(SearchHits hits, InternalAggregations aggregations, Suggest suggest, SearchProfileShardResults profileResults, boolean timedOut, java.lang.Boolean terminatedEarly, int numReducePhases)

InternalSearchResponse

public InternalSearchResponse(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

Method Details

empty

public static InternalSearchResponse empty()

empty

public static InternalSearchResponse empty(boolean withTotalHits)

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SearchResponseSections

Throws:

java.io.IOException