Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class MultiSearchResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.search.MultiSearchResponse

All Implemented Interfaces:

Iterable<MultiSearchResponse.Item>, Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class MultiSearchResponse
extends ActionResponse
implements Iterable<MultiSearchResponse.Item>, ChunkedToXContentObject

A multi search response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultiSearchResponse.Fields
static class	MultiSearchResponse.Item	A search response item, holding the actual search response, or an error message if it failed.

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 inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
MultiSearchResponse(MultiSearchResponse.Item[] items, long tookInMillis)
MultiSearchResponse(StreamInput in)

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.
MultiSearchResponse.Item[]	getResponses()	The list of responses, the order is the same as the one provided in the request.
TimeValue	getTook()	How long the msearch took.
boolean	hasReferences()
void	incRef()
Iterator<MultiSearchResponse.Item>	iterator()
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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

MultiSearchResponse

public MultiSearchResponse(StreamInput in)
                    throws IOException

Throws:

IOException

MultiSearchResponse

public MultiSearchResponse(MultiSearchResponse.Item[] items,
 long tookInMillis)

Parameters:

items - individual search responses, the elements in this array are considered as owned by this instance for ref-counting purposes if their MultiSearchResponse.Item.response is non-null

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

iterator

public Iterator<MultiSearchResponse.Item> iterator()

Specified by:

iterator in interface Iterable<MultiSearchResponse.Item>

getResponses

public MultiSearchResponse.Item[] getResponses()

The list of responses, the order is the same as the one provided in the request.

getTook

public TimeValue getTook()

How long the msearch took.

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

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

toString

public String toString()

Overrides:

toString in class Object