Package org.opensearch.client.opensearch.core.msearch

Class MultiSearchResponseItem<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.msearch.MultiSearchResponseItem<TDocument>

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<MultiSearchResponseItem.Kind,Object>

public class MultiSearchResponseItem<TDocument>
extends Object
implements TaggedUnion<MultiSearchResponseItem.Kind,Object>, JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiSearchResponseItem.Builder<TDocument>
static enum	MultiSearchResponseItem.Kind

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final MultiSearchResponseItem.Kind	_kind()	Get the of the kind of variant held by this object.
static <TDocument> JsonpDeserializer<MultiSearchResponseItem<TDocument>>	createMultiSearchResponseItemDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
ErrorResponse	failure()	Get the failure variant value.
boolean	isFailure()	Is this variant instance of kind failure?
boolean	isResult()	Is this variant instance of kind result?
static <TDocument> MultiSearchResponseItem<TDocument>	of(Function<MultiSearchResponseItem.Builder<TDocument>,ObjectBuilder<MultiSearchResponseItem<TDocument>>> fn)
MultiSearchItem<TDocument>	result()	Get the result variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Method Details

_kind

public final MultiSearchResponseItem.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<MultiSearchResponseItem.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<MultiSearchResponseItem.Kind,Object>

of

public static <TDocument>
MultiSearchResponseItem<TDocument> of(Function<MultiSearchResponseItem.Builder<TDocument>,ObjectBuilder<MultiSearchResponseItem<TDocument>>> fn)

isResult

public boolean isResult()

Is this variant instance of kind result?

result

public MultiSearchItem<TDocument> result()

Get the result variant value.

Throws:

IllegalStateException - if the current variant is not of the result kind.

isFailure

public boolean isFailure()

Is this variant instance of kind failure?

failure

public ErrorResponse failure()

Get the failure variant value.

Throws:

IllegalStateException - if the current variant is not of the failure kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

createMultiSearchResponseItemDeserializer

public static <TDocument>
JsonpDeserializer<MultiSearchResponseItem<TDocument>> createMultiSearchResponseItemDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)