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

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

A multi search response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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.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
MultiSearchResponse(MultiSearchResponse.Item[] items, long tookInMillis)
MultiSearchResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static MultiSearchResponse	fromXContext(XContentParser parser)
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.
Iterator<MultiSearchResponse.Item>	iterator()
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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

MultiSearchResponse

public MultiSearchResponse(StreamInput in)
                    throws IOException

Throws:

IOException

MultiSearchResponse

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

Method Details

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContext

public static MultiSearchResponse fromXContext(XContentParser parser)

toString

public String toString()

Overrides:

toString in class Object