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()
API name:doc
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.final Filter
filter()
API name:filter
final String
id()
The id of the document, when not specified a doc param should be supplied.final String
index()
Required - The index in which the document resides.static <TDocument>
TermvectorsRequest<TDocument>of
(Function<TermvectorsRequest.Builder<TDocument>, ObjectBuilder<TermvectorsRequest<TDocument>>> fn) final Boolean
offsets()
Specifies if term offsets should be returned.final Boolean
payloads()
Specifies if term payloads should be returned.API name:per_field_analyzer
final Boolean
Specifies if term positions should be returned.final String
Specify the node or shard the operation should be performed on (default: random).final Boolean
realtime()
Specifies if request is 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 <TDocument>
voidsetupTermvectorsRequestDeserializer
(ObjectDeserializer<TermvectorsRequest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer) 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 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
API name:doc
-
fieldStatistics
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.API name:
field_statistics
-
fields
A comma-separated list of fields to return.API name:
fields
-
filter
API name:filter
-
id
The id of the document, when not specified a doc param should be supplied.API name:
id
-
index
Required - The index in which the document resides.API name:
index
-
offsets
Specifies if term offsets should be returned.API name:
offsets
-
payloads
Specifies if term payloads should be returned.API name:
payloads
-
perFieldAnalyzer
API name:per_field_analyzer
-
positions
Specifies if term positions should be returned.API name:
positions
-
preference
Specify the node or shard the operation should be performed on (default: random).API name:
preference
-
realtime
Specifies if request is real-time as opposed to near-real-time (default: true).API name:
realtime
-
routing
Specific routing value.API name:
routing
-
termStatistics
Specifies if total term frequency and document frequency should be returned.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
-
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)
-