Package co.elastic.clients.elasticsearch._core

Class IndexRequest.Builder<TDocument>

java.lang.Object
co.elastic.clients.elasticsearch._core.IndexRequest.Builder<TDocument>
All Implemented Interfaces:
ObjectBuilder<IndexRequest<TDocument>>
Enclosing class:
IndexRequest<TDocument>
public static class IndexRequest.Builder<TDocument>
extends java.lang.Object
implements ObjectBuilder<IndexRequest<TDocument>>
Builder for IndexRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      public IndexRequest.Builder<TDocument> id​(@Nullable java.lang.String value)
      Document ID

      API name: id

    • index

      public IndexRequest.Builder<TDocument> index​(java.lang.String value)
      Required - The name of the index

      API name: index

    • type

      public IndexRequest.Builder<TDocument> type​(@Nullable java.lang.String value)
      The type of the document

      API name: type

    • ifPrimaryTerm

      public IndexRequest.Builder<TDocument> ifPrimaryTerm​(@Nullable java.lang.Long value)
      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

      public IndexRequest.Builder<TDocument> ifSeqNo​(@Nullable java.lang.Integer value)
      only perform the index operation if the last operation that has changed the document has the specified sequence number

      API name: if_seq_no

    • opType

      public IndexRequest.Builder<TDocument> opType​(@Nullable OpType value)
      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

      public IndexRequest.Builder<TDocument> pipeline​(@Nullable java.lang.String value)
      The pipeline id to preprocess incoming documents with

      API name: pipeline

    • refresh

      public IndexRequest.Builder<TDocument> refresh​(@Nullable jakarta.json.JsonValue value)
      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

    • routing

      public IndexRequest.Builder<TDocument> routing​(@Nullable java.lang.String value)
      Specific routing value

      API name: routing

    • timeout

      public IndexRequest.Builder<TDocument> timeout​(@Nullable java.lang.String value)
      Explicit operation timeout

      API name: timeout

    • version

      public IndexRequest.Builder<TDocument> version​(@Nullable java.lang.Long value)
      Explicit version number for concurrency control

      API name: version

    • versionType

      public IndexRequest.Builder<TDocument> versionType​(@Nullable VersionType value)
      Specific version type

      API name: version_type

    • waitForActiveShards

      public IndexRequest.Builder<TDocument> waitForActiveShards​(@Nullable jakarta.json.JsonValue value)
      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

    • requireAlias

      public IndexRequest.Builder<TDocument> requireAlias​(@Nullable java.lang.Boolean value)
      When true, requires destination to be an alias. Default is false

      API name: require_alias

    • document

      public IndexRequest.Builder<TDocument> document​(TDocument value)
      Required - Request body.

      API name: _value_body

    • tDocumentSerializer

      public IndexRequest.Builder<TDocument> tDocumentSerializer​(@Nullable JsonpSerializer<TDocument> value)
      Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

    • build

      public IndexRequest<TDocument> build()
      Builds a IndexRequest.
      Specified by:
      build in interface ObjectBuilder<TDocument>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.