Package org.opensearch.script.mustache

Class MultiSearchTemplateResponse

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportResponse

org.opensearch.action.ActionResponse

org.opensearch.script.mustache.MultiSearchTemplateResponse

All Implemented Interfaces:

Iterable<MultiSearchTemplateResponse.Item>, Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class MultiSearchTemplateResponse
extends ActionResponse
implements Iterable<MultiSearchTemplateResponse.Item>, org.opensearch.core.xcontent.ToXContentObject

Nested Class Summary

Nested Classes

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

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

TransportResponse.Empty

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

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

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

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

Field Summary

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static MultiSearchTemplateResponse	fromXContext(org.opensearch.core.xcontent.XContentParser parser)
MultiSearchTemplateResponse.Item[]	getResponses()	The list of responses, the order is the same as the one provided in the request.
TimeValue	getTook()	How long the msearch_template took.
Iterator<MultiSearchTemplateResponse.Item>	iterator()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.opensearch.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 java.lang.Iterable

forEach, spliterator

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

isFragment

Method Details

iterator

public Iterator<MultiSearchTemplateResponse.Item> iterator()

Specified by:

iterator in interface Iterable<MultiSearchTemplateResponse.Item>

getResponses

public MultiSearchTemplateResponse.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_template took.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

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

Throws:

IOException

fromXContext

public static MultiSearchTemplateResponse fromXContext(org.opensearch.core.xcontent.XContentParser parser)

toString

public String toString()

Overrides:

toString in class Object