Class TermvectorsRequest<TDocument>
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.TermvectorsRequest<TDocument>
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class TermvectorsRequest<TDocument>
extends RequestBase
implements JsonpSerializable
Returns information and statistics about terms in the fields of a particular
document.
- 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<TermvectorsRequest<Object>>
Json deserializer forTermvectorsRequest
based on named deserializers provided by the callingJsonMapper
.static final Endpoint<TermvectorsRequest<?>,
TermvectorsResponse, ErrorResponse> Endpoint "termvectors
". -
Method Summary
Modifier and TypeMethodDescriptionstatic <TDocument>
JsonpDeserializer<TermvectorsRequest<TDocument>>createTermvectorsRequestDeserializer
(JsonpDeserializer<TDocument> tDocumentDeserializer) Create a JSON deserializer for TermvectorsRequestfinal TDocument
doc()
An artificial document (a document not present in the index) for which you want to retrieve term vectors.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.final Filter
filter()
Filter terms based on their tf-idf scores.final String
id()
Unique identifier of the document.final String
index()
Required - Name of the index that contains the document.static <TDocument>
TermvectorsRequest<TDocument>of
(Function<TermvectorsRequest.Builder<TDocument>, ObjectBuilder<TermvectorsRequest<TDocument>>> fn) final Boolean
offsets()
Iftrue
, the response includes term offsets.final Boolean
payloads()
Iftrue
, the response includes term payloads.Overrides the default per-field analyzer.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 <TDocument>
voidsetupTermvectorsRequestDeserializer
(ObjectDeserializer<TermvectorsRequest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer) final Boolean
Iftrue
, 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 forTermvectorsRequest
based on named deserializers provided by the callingJsonMapper
. -
_ENDPOINT
Endpoint "termvectors
".
-
-
Method Details
-
of
public static <TDocument> TermvectorsRequest<TDocument> of(Function<TermvectorsRequest.Builder<TDocument>, ObjectBuilder<TermvectorsRequest<TDocument>>> fn) -
doc
An artificial document (a document not present in the index) for which you want to retrieve term vectors.API name:
doc
-
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
-
filter
Filter terms based on their tf-idf scores.API name:
filter
-
id
Unique identifier of the document.API name:
id
-
index
Required - Name of the index that contains the document.API name:
index
-
offsets
Iftrue
, the response includes term offsets.API name:
offsets
-
payloads
Iftrue
, the response includes term payloads.API name:
payloads
-
perFieldAnalyzer
Overrides the default per-field analyzer.API name:
per_field_analyzer
-
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
Iftrue
, 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
-
createTermvectorsRequestDeserializer
public static <TDocument> JsonpDeserializer<TermvectorsRequest<TDocument>> createTermvectorsRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer) Create a JSON deserializer for TermvectorsRequest -
setupTermvectorsRequestDeserializer
protected static <TDocument> void setupTermvectorsRequestDeserializer(ObjectDeserializer<TermvectorsRequest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
-