Package org.opensearch.client.opensearch.core

Class MgetResponse<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.MgetResponse<TDocument>

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class MgetResponse<TDocument>
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MgetResponse.Builder<TDocument>	Builder for MgetResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MgetResponse<Object>>	_DESERIALIZER	Json deserializer for MgetResponse based on named deserializers provided by the calling JsonMapper.

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<MgetResponse<TDocument>>	createMgetResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for MgetResponse
final List<MultiGetResponseItem<TDocument>>	docs()	Required - API name: docs
static <TDocument> MgetResponse<TDocument>	of(Function<MgetResponse.Builder<TDocument>,ObjectBuilder<MgetResponse<TDocument>>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TDocument> void	setupMgetResponseDeserializer(ObjectDeserializer<MgetResponse.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<MgetResponse<Object>> _DESERIALIZER

Json deserializer for MgetResponse based on named deserializers provided by the calling JsonMapper.

Method Details

of

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

docs

public final List<MultiGetResponseItem<TDocument>> docs()

Required - API name: docs

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

createMgetResponseDeserializer

public static <TDocument>
JsonpDeserializer<MgetResponse<TDocument>> createMgetResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for MgetResponse

setupMgetResponseDeserializer

protected static <TDocument> void setupMgetResponseDeserializer(ObjectDeserializer<MgetResponse.Builder<TDocument>> op,
 JsonpDeserializer<TDocument> tDocumentDeserializer)