Package org.opensearch.client.opensearch._global

Class MgetRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.MgetRequest

All Implemented Interfaces:

ToJsonp

public final class MgetRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MgetRequest.Builder	Builder for MgetRequest.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<MgetRequest>	DESERIALIZER	Json deserializer for MgetRequest

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MgetRequest(MgetRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static <TDocument> Endpoint<MgetRequest,MgetResponse<TDocument>,OpenSearchError>	createMgetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "mget" endpoint.
java.util.List<Operation>	docs()	API name: docs
java.util.List<jakarta.json.JsonValue>	ids()	API name: ids
java.lang.String	index()	API name: index
java.lang.String	preference()	API name: preference
java.lang.Boolean	realtime()	API name: realtime
java.lang.Boolean	refresh()	API name: refresh
jakarta.json.JsonValue	routing()	API name: routing
protected static void	setupMgetRequestDeserializer(DelegatingDeserializer<MgetRequest.Builder> op)
jakarta.json.JsonValue	source()	API name: _source
java.util.List<java.lang.String>	sourceExcludes()	API name: _source_excludes
java.util.List<java.lang.String>	sourceIncludes()	API name: _source_includes
java.util.List<java.lang.String>	storedFields()	API name: stored_fields
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.String	type()	API name: type

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<MgetRequest> DESERIALIZER

Json deserializer for MgetRequest

Constructor Details

MgetRequest

protected MgetRequest(MgetRequest.Builder builder)

Method Details

index

@Nullable public java.lang.String index()

API name: index

type

@Nullable public java.lang.String type()

API name: type

preference

@Nullable public java.lang.String preference()

API name: preference

realtime

@Nullable public java.lang.Boolean realtime()

API name: realtime

refresh

@Nullable public java.lang.Boolean refresh()

API name: refresh

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing

source

@Nullable public jakarta.json.JsonValue source()

API name: _source

sourceExcludes

@Nullable public java.util.List<java.lang.String> sourceExcludes()

API name: _source_excludes

sourceIncludes

@Nullable public java.util.List<java.lang.String> sourceIncludes()

API name: _source_includes

storedFields

@Nullable public java.util.List<java.lang.String> storedFields()

API name: stored_fields

docs

@Nullable public java.util.List<Operation> docs()

API name: docs

ids

@Nullable public java.util.List<jakarta.json.JsonValue> ids()

API name: ids

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupMgetRequestDeserializer

protected static void setupMgetRequestDeserializer(DelegatingDeserializer<MgetRequest.Builder> op)

createMgetEndpoint

public static <TDocument> Endpoint<MgetRequest,MgetResponse<TDocument>,OpenSearchError> createMgetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "mget" endpoint.