Package co.elastic.clients.elasticsearch.indices

Class DataLifecycleWithRollover

java.lang.Object

co.elastic.clients.elasticsearch.indices.DataLifecycleWithRollover

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DataLifecycleWithRollover
extends Object
implements JsonpSerializable

Data lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Time	dataRetention()	If defined, every document added to this data stream will be stored at least for this time frame.
static DataLifecycleWithRollover	of(Function<DataLifecycleWithRollover.Builder,ObjectBuilder<DataLifecycleWithRollover>> fn)
final DlmRolloverConditions	rollover()	The conditions which will trigger the rollover of a backing index as configured by the cluster setting cluster.lifecycle.default.rollover.
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	setupDataLifecycleWithRolloverDeserializer(ObjectDeserializer<DataLifecycleWithRollover.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<DataLifecycleWithRollover> _DESERIALIZER

Json deserializer for DataLifecycleWithRollover

Method Details

of

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

dataRetention

@Nullable
public final Time dataRetention()

If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.

API name: data_retention

rollover

@Nullable
public final DlmRolloverConditions rollover()

The conditions which will trigger the rollover of a backing index as configured by the cluster setting cluster.lifecycle.default.rollover. This property is an implementation detail and it will only be retrieved when the query param include_defaults is set to true. The contents of this field are subject to change.

API name: rollover

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

setupDataLifecycleWithRolloverDeserializer

protected static void setupDataLifecycleWithRolloverDeserializer(ObjectDeserializer<DataLifecycleWithRollover.Builder> op)