Class MtermvectorsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.MtermvectorsRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class MtermvectorsRequest
extends RequestBase
implements JsonpSerializable
Returns multiple termvectors in one request.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<MtermvectorsRequest>
Json deserializer forMtermvectorsRequest
static final Endpoint<MtermvectorsRequest,
MtermvectorsResponse, ErrorResponse> Endpoint "mtermvectors
". -
Method Summary
Modifier and TypeMethodDescriptionfinal List<MultiTermVectorsOperation>
docs()
API name:docs
fields()
A comma-separated list of fields to return.final Boolean
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.ids()
API name:ids
final String
index()
The index in which the document resides.static MtermvectorsRequest
final Boolean
offsets()
Specifies if term offsets should be returned.final Boolean
payloads()
Specifies if term payloads should be returned.final Boolean
Specifies if term positions should be returned.final String
Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".final Boolean
realtime()
Specifies if requests are real-time as opposed to near-real-time (default: true).final 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
final Boolean
Specifies if total term frequency and document frequency should be returned.final String
type()
The type of the document.final Long
version()
Explicit version number for concurrency controlfinal VersionType
Specific version typeMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forMtermvectorsRequest
-
_ENDPOINT
Endpoint "mtermvectors
".
-
-
Method Details
-
of
public static MtermvectorsRequest of(Function<MtermvectorsRequest.Builder, ObjectBuilder<MtermvectorsRequest>> fn) -
docs
API name:docs
-
fieldStatistics
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
field_statistics
-
fields
A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
fields
-
ids
API name:ids
-
index
The index in which the document resides.API name:
index
-
offsets
Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
offsets
-
payloads
Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
payloads
-
positions
Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
positions
-
preference
Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
preference
-
realtime
Specifies if requests are real-time as opposed to near-real-time (default: true).API name:
realtime
-
routing
Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
routing
-
termStatistics
Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
term_statistics
-
type
The type of the document.API name:
type
-
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupMtermvectorsRequestDeserializer
protected static void setupMtermvectorsRequestDeserializer(ObjectDeserializer<MtermvectorsRequest.Builder> op)
-