Package org.opensearch.client.opensearch.core

Class MtermvectorsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.core.MtermvectorsRequest
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<MtermvectorsRequest.Builder,MtermvectorsRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class MtermvectorsRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<MtermvectorsRequest.Builder,MtermvectorsRequest>
Returns multiple termvectors in one request.

  • Field Details

  • Method Details

    • of

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

    • docs

      @Nonnull public final List<MultiTermVectorsOperation> docs()
      Array of existing or artificial documents.

      API name: docs

    • 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

      @Nonnull 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

    • ids

      @Nonnull public final List<String> ids()
      Simplified syntax to specify documents by their ID if they're in the same index.

      API name: ids

    • index

      @Nullable public final String index()
      Name of the index that contains the documents.

      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

    • 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

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

    • toBuilder

      @Nonnull public MtermvectorsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MtermvectorsRequest.Builder,MtermvectorsRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static MtermvectorsRequest.Builder builder()

    • setupMtermvectorsRequestDeserializer

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

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object