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:
java.lang.Iterable<MultiSearchResponse.Item>
,Writeable
,org.elasticsearch.common.util.concurrent.RefCounted
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class MultiSearchResponse extends ActionResponse implements java.lang.Iterable<MultiSearchResponse.Item>, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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.common.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(org.elasticsearch.common.xcontent.XContentParser parser)
MultiSearchResponse.Item[]
getResponses()
The list of responses, the order is the same as the one provided in the request.org.elasticsearch.common.unit.TimeValue
getTook()
How long the msearch took.java.util.Iterator<MultiSearchResponse.Item>
iterator()
java.lang.String
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, 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.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
MultiSearchResponse
- Throws:
java.io.IOException
-
MultiSearchResponse
-
-
Method Details
-
iterator
- Specified by:
iterator
in interfacejava.lang.Iterable<MultiSearchResponse.Item>
-
getResponses
The list of responses, the order is the same as the one provided in the request. -
getTook
public org.elasticsearch.common.unit.TimeValue getTook()How long the msearch took. -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
fromXContext
public static MultiSearchResponse fromXContext(org.elasticsearch.common.xcontent.XContentParser parser) -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-