Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class DataStreamGlobalRetentionSettings

java.lang.Object

org.elasticsearch.cluster.metadata.DataStreamGlobalRetentionSettings

public class DataStreamGlobalRetentionSettings
extends Object

This class holds the data stream global retention settings. It defines, validates and monitors the settings.

The global retention settings apply to non-system data streams that are managed by the data stream lifecycle. They consist of: - The default retention which applies to data streams that do not have a retention defined. - The max retention which applies to all data streams that do not have retention or their retention has exceeded this value.

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<TimeValue>	DATA_STREAMS_DEFAULT_RETENTION_SETTING
static final Setting<TimeValue>	DATA_STREAMS_MAX_RETENTION_SETTING
static final TimeValue	MIN_RETENTION_VALUE

Method Summary

Modifier and Type	Method	Description
boolean	areDefined()
static DataStreamGlobalRetentionSettings	create(ClusterSettings clusterSettings)	Creates an instance and initialises the cluster settings listeners
DataStreamGlobalRetention	get()
TimeValue	getDefaultRetention()
TimeValue	getMaxRetention()

Methods inherited from class java.lang.Object

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

Field Details

MIN_RETENTION_VALUE

public static final TimeValue MIN_RETENTION_VALUE

DATA_STREAMS_DEFAULT_RETENTION_SETTING

public static final Setting<TimeValue> DATA_STREAMS_DEFAULT_RETENTION_SETTING

DATA_STREAMS_MAX_RETENTION_SETTING

public static final Setting<TimeValue> DATA_STREAMS_MAX_RETENTION_SETTING

Method Details

getMaxRetention

@Nullable
public TimeValue getMaxRetention()

getDefaultRetention

@Nullable
public TimeValue getDefaultRetention()

areDefined

public boolean areDefined()

create

public static DataStreamGlobalRetentionSettings create(ClusterSettings clusterSettings)

Creates an instance and initialises the cluster settings listeners

Parameters:

clusterSettings - it will register the cluster settings listeners to monitor for changes

get

@Nullable
public DataStreamGlobalRetention get()