Package co.elastic.clients.elasticsearch.core

Class MgetResponse<TDocument>

java.lang.Object

co.elastic.clients.elasticsearch.core.MgetResponse<TDocument>

All Implemented Interfaces:

JsonpSerializable

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

See Also:

• API specification

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 - The response includes a docs array that contains the documents in the order specified in the request.
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)
String	toString()

Methods inherited from class java.lang.Object

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

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 - The response includes a docs array that contains the documents in the order specified in the request. The structure of the returned documents is similar to that returned by the get API. If there is a failure getting a particular document, the error is included in place of the document.

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)

toString

public String toString()

Overrides:

toString in class Object

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)