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()
Array of existing or artificial documents.fields()
Comma-separated list or wildcard expressions of fields to include in the statistics.final Boolean
Iftrue
, the response includes the document count, sum of document frequencies, and sum of total term frequencies.ids()
Simplified syntax to specify documents by their ID if they're in the same index.final String
index()
Name of the index that contains the documents.static MtermvectorsRequest
final Boolean
offsets()
Iftrue
, the response includes term offsets.final Boolean
payloads()
Iftrue
, the response includes term payloads.final Boolean
Iftrue
, the response includes term positions.final String
Specifies the node or shard the operation should be performed on.final Boolean
realtime()
If true, the request is real-time as opposed to near-real-time.final String
routing()
Custom value used to route operations to a specific shard.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
If true, the response includes term frequency and document frequency.final Long
version()
Iftrue
, returns the document version as part of a hit.final VersionType
Specific version type.Methods 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
Array of existing or artificial documents.API name:
docs
-
fieldStatistics
Iftrue
, the response includes the document count, sum of document frequencies, and sum of total term frequencies.API name:
field_statistics
-
fields
Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in thecompletion_fields
orfielddata_fields
parameters.API name:
fields
-
ids
Simplified syntax to specify documents by their ID if they're in the same index.API name:
ids
-
index
Name of the index that contains the documents.API name:
index
-
offsets
Iftrue
, the response includes term offsets.API name:
offsets
-
payloads
Iftrue
, the response includes term payloads.API name:
payloads
-
positions
Iftrue
, the response includes term positions.API name:
positions
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
realtime
If true, the request is real-time as opposed to near-real-time.API name:
realtime
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
termStatistics
If true, the response includes term frequency and document frequency.API name:
term_statistics
-
version
Iftrue
, returns the document version as part of a hit.API name:
version
-
versionType
Specific version type.API name:
version_type
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupMtermvectorsRequestDeserializer
protected static void setupMtermvectorsRequestDeserializer(ObjectDeserializer<MtermvectorsRequest.Builder> op)
-