Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class DataLifecycle

java.lang.Object

org.elasticsearch.cluster.metadata.DataLifecycle

All Implemented Interfaces:

Diffable<DataLifecycle>, SimpleDiffable<DataLifecycle>, Writeable, ToXContent, ToXContentObject

public class DataLifecycle
extends Object
implements SimpleDiffable<DataLifecycle>, ToXContentObject

Holds the Data Lifecycle Management metadata that are configuring how a data stream is managed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DataLifecycle.Retention	Retention is the least amount of time that the data will be kept by elasticsearch.

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<RolloverConfiguration>	CLUSTER_LIFECYCLE_DEFAULT_ROLLOVER_SETTING
static final ParseField	DATA_RETENTION_FIELD
static final String	DATA_STREAM_LIFECYCLE_ORIGIN
static final ConstructingObjectParser<DataLifecycle,Void>	PARSER

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataLifecycle()
DataLifecycle(long timeInMills)
DataLifecycle(DataLifecycle.Retention dataRetention)
DataLifecycle(StreamInput in)
DataLifecycle(TimeValue dataRetention)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static DataLifecycle	fromXContent(XContentParser parser)
TimeValue	getEffectiveDataRetention()	The least amount of time data should be kept by elasticsearch.
int	hashCode()
static boolean	isEnabled()
static Diff<DataLifecycle>	readDiffFrom(StreamInput in)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration)	Converts the data lifecycle to XContent and injects the RolloverConditions if they exist.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

CLUSTER_LIFECYCLE_DEFAULT_ROLLOVER_SETTING

public static final Setting<RolloverConfiguration> CLUSTER_LIFECYCLE_DEFAULT_ROLLOVER_SETTING

DATA_STREAM_LIFECYCLE_ORIGIN

public static final String DATA_STREAM_LIFECYCLE_ORIGIN

See Also:

• Constant Field Values

DATA_RETENTION_FIELD

public static final ParseField DATA_RETENTION_FIELD

PARSER

public static final ConstructingObjectParser<DataLifecycle,Void> PARSER

Constructor Details

DataLifecycle

public DataLifecycle()

DataLifecycle

public DataLifecycle(@Nullable
 TimeValue dataRetention)

DataLifecycle

public DataLifecycle(@Nullable
 DataLifecycle.Retention dataRetention)

DataLifecycle

public DataLifecycle(long timeInMills)

DataLifecycle

public DataLifecycle(StreamInput in)
              throws IOException

Throws:

IOException

Method Details

isEnabled

public static boolean isEnabled()

getEffectiveDataRetention

@Nullable
public TimeValue getEffectiveDataRetention()

The least amount of time data should be kept by elasticsearch.

Returns:

the time period or null, null represents that data should never be deleted.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

readDiffFrom

public static Diff<DataLifecycle> readDiffFrom(StreamInput in)
                                        throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params,
 @Nullable
 RolloverConfiguration rolloverConfiguration)
                           throws IOException

Converts the data lifecycle to XContent and injects the RolloverConditions if they exist.

Throws:

IOException

fromXContent

public static DataLifecycle fromXContent(XContentParser parser)
                                  throws IOException

Throws:

IOException