Package co.elastic.clients.elasticsearch.core.mtermvectors

Class MultiTermVectorsOperation

java.lang.Object
co.elastic.clients.elasticsearch.core.mtermvectors.MultiTermVectorsOperation
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class MultiTermVectorsOperation extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • id

      public final String id()
      Required - The ID of the document.

      API name: _id

    • index

      @Nullable public final String index()
      The index of the document.

      API name: _index

    • doc

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

      API name: doc

    • 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

    • 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

    • filter

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

      API name: filter

    • 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

    • positions

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

      API name: positions

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupMultiTermVectorsOperationDeserializer

      protected static void setupMultiTermVectorsOperationDeserializer(ObjectDeserializer<MultiTermVectorsOperation.Builder> op)