Package co.elastic.clients.elasticsearch.indices

Class TranslogRetention

java.lang.Object

co.elastic.clients.elasticsearch.indices.TranslogRetention

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class TranslogRetention
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Time	age()	This controls the maximum duration for which translog files are kept by each shard.
static TranslogRetention	of(Function<TranslogRetention.Builder,ObjectBuilder<TranslogRetention>> fn)
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	setupTranslogRetentionDeserializer(ObjectDeserializer<TranslogRetention.Builder> op)
final String	size()	This controls the total size of translog files to keep for each shard.
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<TranslogRetention> _DESERIALIZER

Json deserializer for TranslogRetention

Method Details

of

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

size

@Nullable
public final String size()

This controls the total size of translog files to keep for each shard. Keeping more translog files increases the chance of performing an operation based sync when recovering a replica. If the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch versions 7.0.0 and later.

API name: size

age

@Nullable
public final Time age()

This controls the maximum duration for which translog files are kept by each shard. Keeping more translog files increases the chance of performing an operation based sync when recovering replicas. If the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch versions 7.0.0 and later.

API name: age

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

setupTranslogRetentionDeserializer

protected static void setupTranslogRetentionDeserializer(ObjectDeserializer<TranslogRetention.Builder> op)