Package co.elastic.clients.elasticsearch.core

Class IndexRequest<TDocument>

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.IndexRequest<TDocument>
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class IndexRequest<TDocument>
extends RequestBase
implements JsonpSerializable
Creates or updates a document in an index.
See Also:
API specification

  • Field Details

  • Method Details

    • of

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

    • id

      @Nullable public final java.lang.String id()
      Document ID

      API name: id

    • ifPrimaryTerm

      @Nullable public final java.lang.Long ifPrimaryTerm()
      only perform the index operation if the last operation that has changed the document has the specified primary term

      API name: if_primary_term

    • ifSeqNo

      @Nullable public final java.lang.Long ifSeqNo()
      only perform the index operation if the last operation that has changed the document has the specified sequence number

      API name: if_seq_no

    • index

      public final java.lang.String index()
      Required - The name of the index

      API name: index

    • opType

      @Nullable public final OpType opType()
      Explicit operation type. Defaults to index for requests with an explicit document ID, and to createfor requests without an explicit document ID

      API name: op_type

    • pipeline

      @Nullable public final java.lang.String pipeline()
      The pipeline id to preprocess incoming documents with

      API name: pipeline

    • refresh

      @Nullable public final Refresh refresh()
      If true then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false (the default) then do nothing with refreshes.

      API name: refresh

    • requireAlias

      @Nullable public final java.lang.Boolean requireAlias()
      When true, requires destination to be an alias. Default is false

      API name: require_alias

    • routing

      @Nullable public final java.lang.String routing()
      Specific routing value

      API name: routing

    • timeout

      @Nullable public final Time timeout()
      Explicit operation timeout

      API name: timeout

    • 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

    • waitForActiveShards

      @Nullable public final WaitForActiveShards waitForActiveShards()
      Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

      API name: wait_for_active_shards

    • document

      public final TDocument document()
      Required - Request body.

    • serialize

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

    • createIndexRequestDeserializer

      public static <TDocument> JsonpDeserializer<IndexRequest<TDocument>> createIndexRequestDeserializer​(JsonpDeserializer<TDocument> tDocumentDeserializer)