Package co.elastic.clients.elasticsearch.indices

Class SoftDeletes.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<SoftDeletes.Builder>
co.elastic.clients.elasticsearch.indices.SoftDeletes.Builder
All Implemented Interfaces:
WithJson<SoftDeletes.Builder>, ObjectBuilder<SoftDeletes>
Enclosing class:
SoftDeletes
public static class SoftDeletes.Builder extends WithJsonObjectBuilderBase<SoftDeletes.Builder> implements ObjectBuilder<SoftDeletes>
Builder for SoftDeletes.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • enabled

      public final SoftDeletes.Builder enabled(@Nullable Boolean value)
      Indicates whether soft deletes are enabled on the index.

      API name: enabled

    • retentionLease

      public final SoftDeletes.Builder retentionLease(@Nullable RetentionLease value)
      The maximum period to retain a shard history retention lease before it is considered expired. Shard history retention leases ensure that soft deletes are retained during merges on the Lucene index. If a soft delete is merged away before it can be replicated to a follower the following process will fail due to incomplete history on the leader.

      API name: retention_lease

    • retentionLease

      public final SoftDeletes.Builder retentionLease(Function<RetentionLease.Builder,ObjectBuilder<RetentionLease>> fn)
      The maximum period to retain a shard history retention lease before it is considered expired. Shard history retention leases ensure that soft deletes are retained during merges on the Lucene index. If a soft delete is merged away before it can be replicated to a follower the following process will fail due to incomplete history on the leader.

      API name: retention_lease

    • self

      protected SoftDeletes.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<SoftDeletes.Builder>

    • build

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