Package org.opensearch.client.opensearch.indices

Class SoftDeletes.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.SoftDeletes.Builder

All Implemented Interfaces:

CopyableBuilder<SoftDeletes.Builder,SoftDeletes>, MutableBuilder<SoftDeletes.Builder,SoftDeletes>, ObjectBuilder<SoftDeletes>

Enclosing class:

SoftDeletes

public static class SoftDeletes.Builder
extends ObjectBuilderBase
implements CopyableBuilder<SoftDeletes.Builder,SoftDeletes>

Builder for SoftDeletes.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SoftDeletes	build()	Builds a SoftDeletes.
SoftDeletes.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SoftDeletes.Builder	enabled(Boolean value)	Whether soft deletes are enabled on the index.
final SoftDeletes.Builder	retention(Function<SoftDeletesRetention.Builder,ObjectBuilder<SoftDeletesRetention>> fn)	API name: retention
final SoftDeletes.Builder	retention(SoftDeletesRetention value)	API name: retention
final SoftDeletes.Builder	retentionLease(Function<RetentionLease.Builder,ObjectBuilder<RetentionLease>> fn)	API name: retention_lease
final SoftDeletes.Builder	retentionLease(RetentionLease value)	API name: retention_lease

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public SoftDeletes.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<SoftDeletes.Builder,SoftDeletes>

Returns:

a new builder instance.

enabled

@Nonnull
public final SoftDeletes.Builder enabled(@Nullable
 Boolean value)

Whether soft deletes are enabled on the index.

API name: enabled

retention

@Nonnull
public final SoftDeletes.Builder retention(@Nullable
 SoftDeletesRetention value)

API name: retention

retention

@Nonnull
public final SoftDeletes.Builder retention(Function<SoftDeletesRetention.Builder,ObjectBuilder<SoftDeletesRetention>> fn)

API name: retention

retentionLease

@Nonnull
public final SoftDeletes.Builder retentionLease(@Nullable
 RetentionLease value)

API name: retention_lease

retentionLease

@Nonnull
public final SoftDeletes.Builder retentionLease(Function<RetentionLease.Builder,ObjectBuilder<RetentionLease>> fn)

API name: retention_lease

build

@Nonnull
public SoftDeletes build()

Builds a SoftDeletes.

Specified by:

build in interface ObjectBuilder<SoftDeletes>

Throws:

NullPointerException - if some of the required fields are null.