Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Interface DataStreamFactoryRetention

public interface DataStreamFactoryRetention

Holds the factory retention configuration. Factory retention is the global retention configuration meant to be used if a user hasn't provided other retention configuration via DataStreamGlobalRetention metadata in the cluster state.

Method Summary

Modifier and Type	Method	Description
static DataStreamFactoryRetention	emptyFactoryRetention()	Returns empty factory global retention settings.
TimeValue	getDefaultRetention()
TimeValue	getMaxRetention()
void	init(ClusterSettings clusterSettings)	Applies any post constructor initialisation, for example, listening to cluster setting changes.
default boolean	isDefined()
static DataStreamFactoryRetention	load(PluginsService pluginsService, ClusterSettings clusterSettings)	Loads a single instance of a DataStreamFactoryRetention from the PluginsService and finalises the initialisation by calling init(ClusterSettings)

Method Details

getMaxRetention

@Nullable
TimeValue getMaxRetention()

getDefaultRetention

@Nullable
TimeValue getDefaultRetention()

isDefined

default boolean isDefined()

Returns:

true, if at least one of the two settings is not null, false otherwise.

init

void init(ClusterSettings clusterSettings)

Applies any post constructor initialisation, for example, listening to cluster setting changes.

load

static DataStreamFactoryRetention load(PluginsService pluginsService,
 ClusterSettings clusterSettings)

Loads a single instance of a DataStreamFactoryRetention from the PluginsService and finalises the initialisation by calling init(ClusterSettings)

emptyFactoryRetention

static DataStreamFactoryRetention emptyFactoryRetention()

Returns empty factory global retention settings.