Package org.opensearch.script.mustache

Class MultiSearchTemplateResponse.Item

java.lang.Object

org.opensearch.script.mustache.MultiSearchTemplateResponse.Item

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable

Enclosing class:

MultiSearchTemplateResponse

public static class MultiSearchTemplateResponse.Item
extends Object
implements org.opensearch.core.common.io.stream.Writeable

A search template response item, holding the actual search template response, or an error message if it failed.

Nested Class Summary

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

org.opensearch.core.common.io.stream.Writeable.Reader<V extends Object>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V extends Object>

Constructor Summary

Constructors

Constructor	Description
Item(SearchTemplateResponse response, Exception exception)

Method Summary

Modifier and Type	Method	Description
Exception	getFailure()
String	getFailureMessage()	The actual failure message, null if its not a failure.
SearchTemplateResponse	getResponse()	The actual search response, null if its a failure.
boolean	isFailure()	Is it a failed search?
String	toString()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Details

Item

public Item(SearchTemplateResponse response,
 Exception exception)

Method Details

isFailure

public boolean isFailure()

Is it a failed search?

getFailureMessage

@Nullable
public String getFailureMessage()

The actual failure message, null if its not a failure.

getResponse

@Nullable
public SearchTemplateResponse getResponse()

The actual search response, null if its a failure.

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

getFailure

public Exception getFailure()

toString

public String toString()

Overrides:

toString in class Object