Package co.elastic.clients.elasticsearch.indices

Class DataStreamLifecycle

java.lang.Object

co.elastic.clients.elasticsearch.indices.DataStreamLifecycle

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

DataStreamLifecycleWithRollover

@JsonpDeserializable
public class DataStreamLifecycle
extends Object
implements JsonpSerializable

Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataStreamLifecycle.AbstractBuilder<BuilderT extends DataStreamLifecycle.AbstractBuilder<BuilderT>>
static class	DataStreamLifecycle.Builder	Builder for DataStreamLifecycle.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataStreamLifecycle(DataStreamLifecycle.AbstractBuilder<?> builder)

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 DataStreamLifecycle	dataStreamLifecycleOf(Function<DataStreamLifecycle.Builder,ObjectBuilder<DataStreamLifecycle>> fn)
final DataStreamLifecycleDownsampling	downsampling()	The downsampling configuration to execute for the managed backing index after rollover.
final Boolean	enabled()	If defined, it turns data stream lifecycle on/off (true/false) for this data stream.
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 <BuilderT extends DataStreamLifecycle.AbstractBuilder<BuilderT>> void	setupDataStreamLifecycleDeserializer(ObjectDeserializer<BuilderT> 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<DataStreamLifecycle> _DESERIALIZER

Json deserializer for DataStreamLifecycle

Constructor Details

DataStreamLifecycle

protected DataStreamLifecycle(DataStreamLifecycle.AbstractBuilder<?> builder)

Method Details

dataStreamLifecycleOf

public static DataStreamLifecycle dataStreamLifecycleOf(Function<DataStreamLifecycle.Builder,ObjectBuilder<DataStreamLifecycle>> 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

downsampling

@Nullable
public final DataStreamLifecycleDownsampling downsampling()

The downsampling configuration to execute for the managed backing index after rollover.

API name: downsampling

enabled

@Nullable
public final Boolean enabled()

If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.

API name: enabled

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

setupDataStreamLifecycleDeserializer

protected static <BuilderT extends DataStreamLifecycle.AbstractBuilder<BuilderT>>
void setupDataStreamLifecycleDeserializer(ObjectDeserializer<BuilderT> op)