Package org.opensearch.action.get

Class MultiGetResponse

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportResponse

org.opensearch.action.ActionResponse

org.opensearch.action.get.MultiGetResponse

All Implemented Interfaces:

Iterable<MultiGetItemResponse>, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class MultiGetResponse
extends ActionResponse
implements Iterable<MultiGetItemResponse>, org.opensearch.common.xcontent.ToXContentObject

Transport response for a multi get.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiGetResponse.Failure	Represents a failure.

Nested classes/interfaces inherited from class org.opensearch.transport.TransportResponse

TransportResponse.Empty

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 interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MultiGetResponse(MultiGetItemResponse[] responses)

Method Summary

Modifier and Type	Method	Description
static MultiGetResponse	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
MultiGetItemResponse[]	getResponses()
Iterator<MultiGetItemResponse>	iterator()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

isFragment

Constructor Details

MultiGetResponse

public MultiGetResponse(MultiGetItemResponse[] responses)

Method Details

getResponses

public MultiGetItemResponse[] getResponses()

iterator

public Iterator<MultiGetItemResponse> iterator()

Specified by:

iterator in interface Iterable<MultiGetItemResponse>

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

fromXContent

public static MultiGetResponse fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                     throws IOException

Throws:

IOException

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