Package co.elastic.clients.elasticsearch.core

Class TermvectorsRequest<TDocument>

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.TermvectorsRequest<TDocument>
All Implemented Interfaces:
JsonpSerializable
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

  • Field Details

  • Method Details

    • of

      public static <TDocument> TermvectorsRequest<TDocument> of​(java.util.function.Function<TermvectorsRequest.Builder<TDocument>,​ObjectBuilder<TermvectorsRequest<TDocument>>> fn)

    • doc

      @Nullable public final TDocument 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

      @Nullable public final Filter 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

    • type

      @Nullable public final java.lang.String type()
      The type of the document.

      API name: type

    • version

      @Nullable public final java.lang.Long version()
      Explicit version number for concurrency control

      API name: version

    • versionType

      @Nullable public final VersionType versionType()
      Specific version type

      API name: version_type

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • 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)