Class MgetRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.MgetRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class MgetRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MgetRequest.Builder
Builder forMgetRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<MgetRequest>
_DESERIALIZER
Json deserializer forMgetRequest
-
Constructor Summary
Constructors Constructor Description MgetRequest(MgetRequest.Builder builder)
MgetRequest(java.util.function.Function<MgetRequest.Builder,MgetRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description static <TDocument>
Endpoint<MgetRequest,MgetResponse<TDocument>,ElasticsearchError>createMgetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
Create an "mget
" endpoint.java.util.List<Operation>
docs()
API name:docs
java.util.List<java.lang.String>
ids()
API name:ids
java.lang.String
index()
The name of the indexjava.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 modejava.lang.Boolean
refresh()
Refresh the shard containing the document before performing the operationjava.lang.String
routing()
Specific routing valuevoid
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(DelegatingDeserializer<MgetRequest.Builder> op)
jakarta.json.JsonValue
source()
True or false to return the _source field or not, or a list of fields to returnjava.util.List<java.lang.String>
sourceExcludes()
A list of fields to exclude from the returned _source fieldjava.util.List<java.lang.String>
sourceIncludes()
A list of fields to extract and return from the _source fieldjava.util.List<java.lang.String>
storedFields()
A comma-separated list of stored fields to return in the responsejava.lang.String
type()
The type of the documentMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forMgetRequest
-
-
Constructor Details
-
MgetRequest
-
MgetRequest
-
-
Method Details
-
index
@Nullable public java.lang.String index()The name of the indexAPI name:
index
-
type
@Nullable public java.lang.String type()The type of the documentAPI name:
type
-
preference
@Nullable public java.lang.String preference()Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
realtime
@Nullable public java.lang.Boolean realtime()Specify whether to perform the operation in realtime or search modeAPI name:
realtime
-
refresh
@Nullable public java.lang.Boolean refresh()Refresh the shard containing the document before performing the operationAPI name:
refresh
-
routing
@Nullable public java.lang.String routing()Specific routing valueAPI name:
routing
-
source
@Nullable public jakarta.json.JsonValue source()True or false to return the _source field or not, or a list of fields to returnAPI name:
_source
-
sourceExcludes
@Nullable public java.util.List<java.lang.String> sourceExcludes()A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
-
sourceIncludes
@Nullable public java.util.List<java.lang.String> sourceIncludes()A list of fields to extract and return from the _source fieldAPI name:
_source_includes
-
storedFields
@Nullable public java.util.List<java.lang.String> storedFields()A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
-
docs
API name:docs
-
ids
@Nullable public java.util.List<java.lang.String> ids()API name:ids
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupMgetRequestDeserializer
-
createMgetEndpoint
public static <TDocument> Endpoint<MgetRequest,MgetResponse<TDocument>,ElasticsearchError> createMgetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)Create an "mget
" endpoint.
-