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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TermvectorsRequest.Builder<TDocument>
Builder forTermvectorsRequest
.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<TermvectorsRequest<java.lang.Object>>
_DESERIALIZER
Json deserializer forTermvectorsRequest
based on named deserializers provided by the callingJsonMapper
.static Endpoint<TermvectorsRequest<?>,TermvectorsResponse,ErrorResponse>
_ENDPOINT
Endpoint "termvectors
". -
Method Summary
Modifier and Type Method Description static <TDocument>
JsonpDeserializer<TermvectorsRequest<TDocument>>createTermvectorsRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
Create a JSON deserializer for TermvectorsRequestTDocument
doc()
API name:doc
java.util.List<java.lang.String>
fields()
A comma-separated list of fields to return.java.lang.Boolean
fieldStatistics()
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.Filter
filter()
API name:filter
java.lang.String
id()
The id of the document, when not specified a doc param should be supplied.java.lang.String
index()
Required - The index in which the document resides.static <TDocument>
TermvectorsRequest<TDocument>of(java.util.function.Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)
java.lang.Boolean
offsets()
Specifies if term offsets should be returned.java.lang.Boolean
payloads()
Specifies if term payloads should be returned.java.util.Map<java.lang.String,java.lang.String>
perFieldAnalyzer()
API name:per_field_analyzer
java.lang.Boolean
positions()
Specifies if term positions should be returned.java.lang.String
preference()
Specify the node or shard the operation should be performed on (default: random).java.lang.Boolean
realtime()
Specifies if request is real-time as opposed to near-real-time (default: true).java.lang.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)
java.lang.Boolean
termStatistics()
Specifies if total term frequency and document frequency should be returned.java.lang.Long
version()
Explicit version number for concurrency controlVersionType
versionType()
Specific version typeMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
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(java.util.function.Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn) -
doc
API name:doc
-
fieldStatistics
@Nullable public final java.lang.Boolean fieldStatistics()Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.API name:
field_statistics
-
fields
public final java.util.List<java.lang.String> fields()A comma-separated list of fields to return.API name:
fields
-
filter
API name:filter
-
id
@Nullable public final java.lang.String id()The id of the document, when not specified a doc param should be supplied.API name:
id
-
index
public final java.lang.String index()Required - The index in which the document resides.API name:
index
-
offsets
@Nullable public final java.lang.Boolean offsets()Specifies if term offsets should be returned.API name:
offsets
-
payloads
@Nullable public final java.lang.Boolean payloads()Specifies if term payloads should be returned.API name:
payloads
-
perFieldAnalyzer
public final java.util.Map<java.lang.String,java.lang.String> perFieldAnalyzer()API name:per_field_analyzer
-
positions
@Nullable public final java.lang.Boolean positions()Specifies if term positions should be returned.API name:
positions
-
preference
@Nullable public final java.lang.String preference()Specify the node or shard the operation should be performed on (default: random).API name:
preference
-
realtime
@Nullable public final java.lang.Boolean realtime()Specifies if request is real-time as opposed to near-real-time (default: true).API name:
realtime
-
routing
@Nullable public final java.lang.String routing()Specific routing value.API name:
routing
-
termStatistics
@Nullable public final java.lang.Boolean termStatistics()Specifies if total term frequency and document frequency should be returned.API name:
term_statistics
-
version
@Nullable public final java.lang.Long 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)
-