Package co.elastic.clients.elasticsearch.core

Class MtermvectorsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.MtermvectorsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class MtermvectorsRequest extends RequestBase implements JsonpSerializable
Returns multiple termvectors in one request.
See Also:

  • Field Details

  • Method Details

    • of

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

    • docs

      public final List<MultiTermVectorsOperation> docs()
      API name: docs

    • fieldStatistics

      @Nullable public final Boolean fieldStatistics()
      Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: field_statistics

    • fields

      public final List<String> fields()
      A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: fields

    • ids

      public final List<String> ids()
      API name: ids

    • index

      @Nullable public final String index()
      The index in which the document resides.

      API name: index

    • offsets

      @Nullable public final Boolean offsets()
      Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: offsets

    • payloads

      @Nullable public final Boolean payloads()
      Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: payloads

    • positions

      @Nullable public final Boolean positions()
      Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: positions

    • preference

      @Nullable public final String preference()
      Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: preference

    • realtime

      @Nullable public final Boolean realtime()
      Specifies if requests are real-time as opposed to near-real-time (default: true).

      API name: realtime

    • routing

      @Nullable public final String routing()
      Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: routing

    • termStatistics

      @Nullable public final Boolean termStatistics()
      Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".

      API name: term_statistics

    • type

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

      API name: type

    • version

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

    • setupMtermvectorsRequestDeserializer

      protected static void setupMtermvectorsRequestDeserializer(ObjectDeserializer<MtermvectorsRequest.Builder> op)