Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ilm

Class GenerateSnapshotNameStep

java.lang.Object

org.elasticsearch.xpack.core.ilm.Step

org.elasticsearch.xpack.core.ilm.ClusterStateActionStep

org.elasticsearch.xpack.core.ilm.GenerateSnapshotNameStep

public class GenerateSnapshotNameStep
extends ClusterStateActionStep

Generates a snapshot name for the given index and records it in the index metadata along with the provided snapshot repository.

The generated snapshot name will be in the format {day-indexName-policyName-randomUUID} eg.: 2020.03.30-myindex-mypolicy-cmuce-qfvmn_dstqw-ivmjc1etsa

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.core.ilm.Step

Step.StepKey

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
GenerateSnapshotNameStep(Step.StepKey key, Step.StepKey nextStepKey, String snapshotRepository, BiFunction<String,LifecycleExecutionState,String> targetIndexNameSupplier)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static String	generateSnapshotName(String name)	Since snapshots need to be uniquely named, this method will resolve any date math used in the provided name, as well as appending a unique identifier so expressions that may overlap still result in unique snapshot names.
static String	generateSnapshotName(String name, long now)
String	getSnapshotRepository()
int	hashCode()
boolean	isRetryable()	Indicates if the step can be automatically retried when it encounters an execution error.
ProjectState	performAction(Index index, ProjectState projectState)
static ActionRequestValidationException	validateGeneratedSnapshotName(String snapshotPrefix, String snapshotName)

Methods inherited from class org.elasticsearch.xpack.core.ilm.ClusterStateActionStep

indexForAsyncInvocation

Methods inherited from class org.elasticsearch.xpack.core.ilm.Step

getCurrentStepKey, getKey, getNextStepKey, toString

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

GenerateSnapshotNameStep

public GenerateSnapshotNameStep(Step.StepKey key,
 Step.StepKey nextStepKey,
 String snapshotRepository,
 BiFunction<String,LifecycleExecutionState,String> targetIndexNameSupplier)

Method Details

getSnapshotRepository

public String getSnapshotRepository()

performAction

public ProjectState performAction(Index index,
 ProjectState projectState)

Specified by:

performAction in class ClusterStateActionStep

isRetryable

public boolean isRetryable()

Description copied from class: Step

Indicates if the step can be automatically retried when it encounters an execution error.

Specified by:

isRetryable in class Step

hashCode

public int hashCode()

Overrides:

hashCode in class Step

equals

public boolean equals(Object obj)

Overrides:

equals in class Step

generateSnapshotName

public static String generateSnapshotName(String name)

Since snapshots need to be uniquely named, this method will resolve any date math used in the provided name, as well as appending a unique identifier so expressions that may overlap still result in unique snapshot names.

generateSnapshotName

public static String generateSnapshotName(String name,
 long now)

validateGeneratedSnapshotName

@Nullable
public static ActionRequestValidationException validateGeneratedSnapshotName(String snapshotPrefix,
 String snapshotName)