java.lang.Object
org.elasticsearch.xpack.core.ilm.Step
org.elasticsearch.xpack.core.ilm.AsyncActionStep
org.elasticsearch.xpack.core.ilm.UpdateSettingsStep
Updates the settings for an index.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.xpack.core.ilm.Step
Step.StepKey -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionUpdateSettingsStep(Step.StepKey key, Step.StepKey nextStepKey, Client client, BiFunction<String, LifecycleExecutionState, String> targetIndexNameSupplier, Function<IndexMetadata, Settings> settingsSupplier) Use this constructor when you want to update an index other than the one ILM runs on, and/or when you have non-constant settings (i.e., settings that depend on the index metadata).UpdateSettingsStep(Step.StepKey key, Step.StepKey nextStepKey, Client client, Settings settings) Use this constructor when you want to update the index that ILM runs on with constant settings. -
Method Summary
Modifier and TypeMethodDescriptionbooleanIndicates if the step can be automatically retried when it encounters an execution error.voidperformAction(IndexMetadata indexMetadata, ProjectState currentState, ClusterStateObserver observer, ActionListener<Void> listener) Methods inherited from class org.elasticsearch.xpack.core.ilm.AsyncActionStep
getClient, indexSurvivesMethods inherited from class org.elasticsearch.xpack.core.ilm.Step
equals, getCurrentStepKey, getKey, getNextStepKey, hashCode, toString
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
UpdateSettingsStep
public UpdateSettingsStep(Step.StepKey key, Step.StepKey nextStepKey, Client client, Settings settings) Use this constructor when you want to update the index that ILM runs on with constant settings. -
UpdateSettingsStep
public UpdateSettingsStep(Step.StepKey key, Step.StepKey nextStepKey, Client client, BiFunction<String, LifecycleExecutionState, String> targetIndexNameSupplier, Function<IndexMetadata, Settings> settingsSupplier) Use this constructor when you want to update an index other than the one ILM runs on, and/or when you have non-constant settings (i.e., settings that depend on the index metadata).
-
-
Method Details
-
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
-
performAction
public void performAction(IndexMetadata indexMetadata, ProjectState currentState, ClusterStateObserver observer, ActionListener<Void> listener) - Specified by:
performActionin classAsyncActionStep
-
getSettingsSupplier
-