Package org.opensearch.client.opensearch.core.mget

Class MultiGetResponseItem<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.mget.MultiGetResponseItem<TDocument>

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<MultiGetResponseItem.Kind,java.lang.Object>

public class MultiGetResponseItem<TDocument>
extends java.lang.Object
implements TaggedUnion<MultiGetResponseItem.Kind,java.lang.Object>, JsonpSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
MultiGetResponseItem.Kind	_kind()	Get the of the kind of variant held by this object.
static <TDocument> JsonpDeserializer<MultiGetResponseItem<TDocument>>	createMultiGetResponseItemDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
MultiGetError	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> MultiGetResponseItem<TDocument>	of(java.util.function.Function<MultiGetResponseItem.Builder<TDocument>,ObjectBuilder<MultiGetResponseItem<TDocument>>> fn)
GetResult<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 Detail

_kind

public final MultiGetResponseItem.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<MultiGetResponseItem.Kind,java.lang.Object>

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

_get in interface TaggedUnion<MultiGetResponseItem.Kind,java.lang.Object>

of

public static <TDocument> MultiGetResponseItem<TDocument> of(java.util.function.Function<MultiGetResponseItem.Builder<TDocument>,ObjectBuilder<MultiGetResponseItem<TDocument>>> fn)

isResult

public boolean isResult()

Is this variant instance of kind result?

result

public GetResult<TDocument> result()

Get the result variant value.

Throws:

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

isFailure

public boolean isFailure()

Is this variant instance of kind failure?

failure

public MultiGetError failure()

Get the failure variant value.

Throws:

java.lang.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

createMultiGetResponseItemDeserializer

public static <TDocument> JsonpDeserializer<MultiGetResponseItem<TDocument>> createMultiGetResponseItemDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)