Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ilm

Class TimeseriesLifecycleType

java.lang.Object

org.elasticsearch.xpack.core.ilm.TimeseriesLifecycleType

All Implemented Interfaces:

NamedWriteable, Writeable, LifecycleType

public class TimeseriesLifecycleType
extends Object
implements LifecycleType

Represents the lifecycle of an index from creation to deletion. A TimeseriesLifecycleType is made up of a set of Phases which it will move through. Soon we will constrain the phases using some kinda of lifecycle type which will allow only particular Phases to be defined, will dictate the order in which the Phases are executed and will define which LifecycleActions are allowed in each phase.

Nested Class Summary

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 Set<String>	ACTIONS_CANNOT_FOLLOW_SEARCHABLE_SNAPSHOT
static final TimeseriesLifecycleType	INSTANCE
static final List<String>	ORDERED_VALID_COLD_ACTIONS
static final List<String>	ORDERED_VALID_DELETE_ACTIONS
static final List<String>	ORDERED_VALID_FROZEN_ACTIONS
static final List<String>	ORDERED_VALID_HOT_ACTIONS
static final List<String>	ORDERED_VALID_PHASES
static final List<String>	ORDERED_VALID_WARM_ACTIONS
static final Set<String>	READ_ONLY_ACTIONS	We define the following actions as read-only, because either they explicitly set an index to be read-only (read-only, downsample, searchable snapshot, shrink) or adding data during their operation could be tricky, like force-merge.
static final String	TYPE

Method Summary

Modifier and Type	Method	Description
List<LifecycleAction>	getOrderedActions(Phase phase)
List<Phase>	getOrderedPhases(Map<String,Phase> phases)
String	getWriteableName()
static boolean	shouldInjectMigrateStepForPhase(Phase phase)
void	validate(Collection<Phase> phases)	validates whether the specified phases are valid for this policy instance.
static String	validateMonotonicallyIncreasingPhaseTimings(Collection<Phase> phases)	Validates that phases don't configure a min_age that is smaller than a previous phase (which can be confusing to users)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final TimeseriesLifecycleType INSTANCE

TYPE

public static final String TYPE

See Also:

• Constant Field Values

ORDERED_VALID_PHASES

public static final List<String> ORDERED_VALID_PHASES

ORDERED_VALID_HOT_ACTIONS

public static final List<String> ORDERED_VALID_HOT_ACTIONS

ORDERED_VALID_WARM_ACTIONS

public static final List<String> ORDERED_VALID_WARM_ACTIONS

ORDERED_VALID_COLD_ACTIONS

public static final List<String> ORDERED_VALID_COLD_ACTIONS

ORDERED_VALID_FROZEN_ACTIONS

public static final List<String> ORDERED_VALID_FROZEN_ACTIONS

ORDERED_VALID_DELETE_ACTIONS

public static final List<String> ORDERED_VALID_DELETE_ACTIONS

READ_ONLY_ACTIONS

public static final Set<String> READ_ONLY_ACTIONS

We define the following actions as read-only, because either they explicitly set an index to be read-only (read-only, downsample, searchable snapshot, shrink) or adding data during their operation could be tricky, like force-merge. Finally, delete is also considered a read-only operation because any data that would be added would be removed asap. These actions are used to determine if we will create a new past backing index in a TSDB to cover documents with older timestamps than the time frame covered by existing indices.

ACTIONS_CANNOT_FOLLOW_SEARCHABLE_SNAPSHOT

public static final Set<String> ACTIONS_CANNOT_FOLLOW_SEARCHABLE_SNAPSHOT

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

getOrderedPhases

public List<Phase> getOrderedPhases(Map<String,Phase> phases)

Specified by:

getOrderedPhases in interface LifecycleType

Returns:

the first phase of this policy to execute

shouldInjectMigrateStepForPhase

public static boolean shouldInjectMigrateStepForPhase(Phase phase)

getOrderedActions

public List<LifecycleAction> getOrderedActions(Phase phase)

Specified by:

getOrderedActions in interface LifecycleType

validate

public void validate(Collection<Phase> phases)

Description copied from interface: LifecycleType

validates whether the specified phases are valid for this policy instance.

Specified by:

validate in interface LifecycleType

Parameters:

phases - the phases to verify validity against

validateMonotonicallyIncreasingPhaseTimings

public static String validateMonotonicallyIncreasingPhaseTimings(Collection<Phase> phases)

Validates that phases don't configure a min_age that is smaller than a previous phase (which can be confusing to users)