Package co.elastic.clients.elasticsearch.indices

Class SoftDeletes

java.lang.Object

co.elastic.clients.elasticsearch.indices.SoftDeletes

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SoftDeletes
extends Object
implements JsonpSerializable

See Also:

• API specification

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
final Boolean	enabled()	Indicates whether soft deletes are enabled on the index.
static SoftDeletes	of(Function<SoftDeletes.Builder,ObjectBuilder<SoftDeletes>> fn)
final RetentionLease	retentionLease()	The maximum period to retain a shard history retention lease before it is considered expired.
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)
String	toString()

Methods inherited from class java.lang.Object

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

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()

Indicates whether soft deletes are enabled on the index.

API name: enabled

retentionLease

@Nullable
public final RetentionLease retentionLease()

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

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)

toString

public String toString()

Overrides:

toString in class Object

setupSoftDeletesDeserializer

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