Package org.opensearch.client.opensearch.indices

Class SoftDeletes

java.lang.Object

org.opensearch.client.opensearch.indices.SoftDeletes

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SoftDeletes.Builder,SoftDeletes>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class SoftDeletes
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<SoftDeletes.Builder,SoftDeletes>

The configuration for soft deletes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SoftDeletes.Builder	Builder for SoftDeletes.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SoftDeletes>	_DESERIALIZER	Json deserializer for SoftDeletes

Method Summary

Modifier and Type	Method	Description
static SoftDeletes.Builder	builder()
final Boolean	enabled()	Whether soft deletes are enabled on the index.
boolean	equals(Object o)
int	hashCode()
static SoftDeletes	of(Function<SoftDeletes.Builder,ObjectBuilder<SoftDeletes>> fn)
final SoftDeletesRetention	retention()	API name: retention
final RetentionLease	retentionLease()	API name: retention_lease
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSoftDeletesDeserializer(ObjectDeserializer<SoftDeletes.Builder> op)
SoftDeletes.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SoftDeletes> _DESERIALIZER

Json deserializer for SoftDeletes

Method Details

of

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

enabled

@Nullable
public final Boolean enabled()

Whether soft deletes are enabled on the index.

API name: enabled

retention

@Nullable
public final SoftDeletesRetention retention()

API name: retention

retentionLease

@Nullable
public final RetentionLease retentionLease()

API name: retention_lease

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 SoftDeletes.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<SoftDeletes.Builder,SoftDeletes>

Returns:

a new builder instance.

builder

@Nonnull
public static SoftDeletes.Builder builder()

setupSoftDeletesDeserializer

protected static void setupSoftDeletesDeserializer(ObjectDeserializer<SoftDeletes.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object