java.lang.Object
org.elasticsearch.xpack.core.ilm.Step
org.elasticsearch.xpack.core.ilm.AsyncActionStep
org.elasticsearch.xpack.core.ilm.AsyncRetryDuringSnapshotActionStep
org.elasticsearch.xpack.core.ilm.DeleteStep
Deletes a single index.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.xpack.core.ilm.Step
Step.StepKey -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDeleteStep(Step.StepKey key, Step.StepKey nextStepKey, Client client) Use this constructor to delete the index that ILM is currently operating on.DeleteStep(Step.StepKey key, Step.StepKey nextStepKey, Client client, BiFunction<String, LifecycleExecutionState, String> targetIndexNameSupplier, boolean indexSurvives) Use this constructor to delete a specific index, potentially different from the one that ILM is currently operating on. -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanIndicates if the step can be automatically retried when it encounters an execution error.voidperformDuringNoSnapshot(IndexMetadata indexMetadata, ProjectMetadata currentProject, ActionListener<Void> listener) Methods inherited from class org.elasticsearch.xpack.core.ilm.AsyncRetryDuringSnapshotActionStep
performActionMethods inherited from class org.elasticsearch.xpack.core.ilm.AsyncActionStep
getClientMethods inherited from class org.elasticsearch.xpack.core.ilm.Step
equals, getCurrentStepKey, getKey, getNextStepKey, hashCode, toString
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
DeleteStep
Use this constructor to delete the index that ILM is currently operating on. -
DeleteStep
public DeleteStep(Step.StepKey key, Step.StepKey nextStepKey, Client client, BiFunction<String, LifecycleExecutionState, String> targetIndexNameSupplier, boolean indexSurvives) Use this constructor to delete a specific index, potentially different from the one that ILM is currently operating on. The parameterindexSurvivesindicates whether the index that ILM runs on will survive (i.e. not get deleted) this step. Look at the callers ofAsyncActionStep.indexSurvives()for more details.
-
-
Method Details
-
performDuringNoSnapshot
public void performDuringNoSnapshot(IndexMetadata indexMetadata, ProjectMetadata currentProject, ActionListener<Void> listener) -
indexSurvives
public boolean indexSurvives()- Overrides:
indexSurvivesin classAsyncActionStep
-
isRetryable
public boolean isRetryable()Description copied from class:StepIndicates if the step can be automatically retried when it encounters an execution error.- Specified by:
isRetryablein classStep
-