Package org.opensearch.client.opensearch.core

Class MgetRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.MgetRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class MgetRequest
extends RequestBase
implements JsonpSerializable

Allows to get multiple documents in one request.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<MgetRequest>	_DESERIALIZER	Json deserializer for MgetRequest
static SimpleEndpoint<MgetRequest,?>	_ENDPOINT	Endpoint "mget".

Method Summary

Modifier and Type	Method	Description
static <TDocument> Endpoint<MgetRequest,MgetResponse<TDocument>,ErrorResponse>	createMgetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "mget" endpoint.
java.util.List<MultiGetOperation>	docs()	API name: docs
java.util.List<java.lang.String>	ids()	API name: ids
java.lang.String	index()	The name of the index
static MgetRequest	of(java.util.function.Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn)
java.lang.String	preference()	Specify the node or shard the operation should be performed on (default: random)
java.lang.Boolean	realtime()	Specify whether to perform the operation in realtime or search mode
java.lang.Boolean	refresh()	Refresh the shard containing the document before performing the operation
java.lang.String	routing()	Specific routing value
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 void	setupMgetRequestDeserializer(ObjectDeserializer<MgetRequest.Builder> op)
SourceConfigParam	source()	True or false to return the _source field or not, or a list of fields to return
java.util.List<java.lang.String>	sourceExcludes()	A list of fields to exclude from the returned _source field
java.util.List<java.lang.String>	sourceIncludes()	A list of fields to extract and return from the _source field
java.util.List<java.lang.String>	storedFields()	A comma-separated list of stored fields to return in the response

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<MgetRequest> _DESERIALIZER

Json deserializer for MgetRequest

_ENDPOINT

public static final SimpleEndpoint<MgetRequest,?> _ENDPOINT

Endpoint "mget".

Method Detail

of

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

source

@Nullable
public final SourceConfigParam source()

True or false to return the _source field or not, or a list of fields to return

API name: _source

sourceExcludes

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

A list of fields to exclude from the returned _source field

API name: _source_excludes

sourceIncludes

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

A list of fields to extract and return from the _source field

API name: _source_includes

docs

public final java.util.List<MultiGetOperation> docs()

API name: docs

ids

public final java.util.List<java.lang.String> ids()

API name: ids

index

@Nullable
public final java.lang.String index()

The name of the index

API name: index

preference

@Nullable
public final java.lang.String preference()

Specify the node or shard the operation should be performed on (default: random)

API name: preference

realtime

@Nullable
public final java.lang.Boolean realtime()

Specify whether to perform the operation in realtime or search mode

API name: realtime

refresh

@Nullable
public final java.lang.Boolean refresh()

Refresh the shard containing the document before performing the operation

API name: refresh

routing

@Nullable
public final java.lang.String routing()

Specific routing value

API name: routing

storedFields

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

A comma-separated list of stored fields to return in the response

API name: stored_fields

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)

setupMgetRequestDeserializer

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

createMgetEndpoint

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

Create an "mget" endpoint.