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
@JsonpDeserializable public class TermvectorsRequest<TDocument> extends RequestBase implements JsonpSerializable
Returns information and statistics about terms in the fields of a particular document.
See Also:

  • Field Details

  • Method Details

    • of

      public static <TDocument> TermvectorsRequest<TDocument> of(Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)

    • doc

      @Nullable public final TDocument doc()
      An artificial document (a document not present in the index) for which you want to retrieve term vectors.

      API name: doc

    • fieldStatistics

      @Nullable public final Boolean fieldStatistics()
      If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.

      API name: field_statistics

    • fields

      public final List<String> 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 the completion_fields or fielddata_fields parameters.

      API name: fields

    • filter

      @Nullable public final Filter filter()
      Filter terms based on their tf-idf scores.

      API name: filter

    • id

      @Nullable public final String id()
      Unique identifier of the document.

      API name: id

    • index

      public final String index()
      Required - Name of the index that contains the document.

      API name: index

    • offsets

      @Nullable public final Boolean offsets()
      If true, the response includes term offsets.

      API name: offsets

    • payloads

      @Nullable public final Boolean payloads()
      If true, the response includes term payloads.

      API name: payloads

    • perFieldAnalyzer

      public final Map<String,String> perFieldAnalyzer()
      Overrides the default per-field analyzer.

      API name: per_field_analyzer

    • positions

      @Nullable public final Boolean positions()
      If true, the response includes term positions.

      API name: positions

    • preference

      @Nullable public final String preference()
      Specifies the node or shard the operation should be performed on. Random by default.

      API name: preference

    • realtime

      @Nullable public final Boolean realtime()
      If true, the request is real-time as opposed to near-real-time.

      API name: realtime

    • routing

      @Nullable public final String routing()
      Custom value used to route operations to a specific shard.

      API name: routing

    • termStatistics

      @Nullable public final Boolean termStatistics()
      If true, the response includes term frequency and document frequency.

      API name: term_statistics

    • version

      @Nullable public final Long version()
      If true, returns the document version as part of a hit.

      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)