Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ilm

Class LifecyclePolicy

java.lang.Object

org.elasticsearch.xpack.core.ilm.LifecyclePolicy

All Implemented Interfaces:

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

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

Represents the lifecycle of an index from creation to deletion. A LifecyclePolicy is made up of a set of Phases which it will move through. Policies are constrained by a LifecycleType which governs which Phases and LifecycleActions are allowed to be defined and in which order they are executed.

Nested Class Summary

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 ConstructingObjectParser<LifecyclePolicy,String>	PARSER
static final ParseField	PHASES_FIELD

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
LifecyclePolicy(String name, Map<String,Phase> phases)
LifecyclePolicy(StreamInput in)	For Serialization
LifecyclePolicy(LifecycleType type, String name, Map<String,Phase> phases, Map<String,Object> metadata)
LifecyclePolicy(LifecycleType type, String name, Map<String,Phase> phases, Map<String,Object> metadata, Boolean deprecated)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Boolean	getDeprecated()
Map<String,Object>	getMetadata()
String	getName()
Map<String,Phase>	getPhases()
LifecycleType	getType()
int	hashCode()
boolean	isActionSafe(Step.StepKey stepKey)
boolean	isDeprecated()
boolean	maybeAddDeprecationWarningForFreezeAction(String policyName)
static LifecyclePolicy	parse(XContentParser parser, String name)
List<Step>	toSteps(Client client, XPackLicenseState licenseState)	This method is used to compile this policy into its execution plan built out of Step instances.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validate()
static void	validatePolicyName(String policy)	Validate the name for an policy against some static rules.
void	writeTo(StreamOutput out)

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

PHASES_FIELD

public static final ParseField PHASES_FIELD

PARSER

public static final ConstructingObjectParser<LifecyclePolicy,String> PARSER

Constructor Details

LifecyclePolicy

public LifecyclePolicy(String name,
 Map<String,Phase> phases)

Parameters:

name - the name of this LifecyclePolicy

phases - a Map of Phases which make up this LifecyclePolicy.

LifecyclePolicy

public LifecyclePolicy(LifecycleType type,
 String name,
 Map<String,Phase> phases,
 @Nullable
 Map<String,Object> metadata)

Parameters:

type - the LifecycleType of the policy

name - the name of this LifecyclePolicy

phases - a Map of Phases which make up this LifecyclePolicy.

metadata - the custom metadata of this LifecyclePolicy

LifecyclePolicy

public LifecyclePolicy(StreamInput in)
                throws IOException

For Serialization

Throws:

IOException

LifecyclePolicy

public LifecyclePolicy(LifecycleType type,
 String name,
 Map<String,Phase> phases,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 Boolean deprecated)

Parameters:

type - the LifecycleType of the policy

name - the name of this LifecyclePolicy

phases - a Map of Phases which make up this LifecyclePolicy.

metadata - the custom metadata of this LifecyclePolicy

Method Details

validate

public void validate()

parse

public static LifecyclePolicy parse(XContentParser parser,
 String name)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getName

public String getName()

Returns:

the name of this LifecyclePolicy

getType

public LifecycleType getType()

Returns:

the type of this LifecyclePolicy

getPhases

public Map<String,Phase> getPhases()

Returns:

the Phases for this LifecyclePolicy in the order in which they will be executed.

getMetadata

public Map<String,Object> getMetadata()

Returns:

the custom metadata of this LifecyclePolicy

getDeprecated

public Boolean getDeprecated()

isDeprecated

public boolean isDeprecated()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toSteps

public List<Step> toSteps(Client client,
 XPackLicenseState licenseState)

This method is used to compile this policy into its execution plan built out of Step instances. The order of the Phases and LifecycleActions is determined by the LifecycleType associated with this policy.

The order of the policy will have this structure:

- initialize policy context step - phase-1 phase-after-step - ... phase-1 action steps - phase-2 phase-after-step - ... - terminal policy step

We first initialize the policy's context and ensure that the index has proper settings set. Then we begin each phase's after-step along with all its actions as steps. Finally, we have a terminal step to inform us that this policy's steps are all complete. Each phase's `after` step is associated with the previous phase's phase. For example, the warm phase's `after` is associated with the hot phase so that it is clear that we haven't stepped into the warm phase just yet (until this step is complete).

Parameters:

client - The Elasticsearch Client to use during execution of AsyncActionStep and AsyncWaitStep steps.

licenseState - The license state to use in actions and steps

Returns:

The list of Step objects in order of their execution.

isActionSafe

public boolean isActionSafe(Step.StepKey stepKey)

validatePolicyName

public static void validatePolicyName(String policy)

Validate the name for an policy against some static rules. Intended to match MetadataCreateIndexService.validateIndexOrAliasName(String, BiFunction)

Parameters:

policy - the policy name to validate

Throws:

IllegalArgumentException - if the name is invalid

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

maybeAddDeprecationWarningForFreezeAction

public boolean maybeAddDeprecationWarningForFreezeAction(String policyName)