Package org.elasticsearch.upgrades
Class MigrationResultsUpdateTask
java.lang.Object
org.elasticsearch.cluster.ClusterStateUpdateTask
org.elasticsearch.upgrades.MigrationResultsUpdateTask
- All Implemented Interfaces:
ClusterStateTaskConfig
,ClusterStateTaskExecutor<ClusterStateUpdateTask>
,ClusterStateTaskListener
Handles updating the
FeatureMigrationResults
in the cluster state.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.cluster.ClusterStateTaskConfig
ClusterStateTaskConfig.Basic
Nested classes/interfaces inherited from interface org.elasticsearch.cluster.ClusterStateTaskExecutor
ClusterStateTaskExecutor.ClusterTasksResult<T>, ClusterStateTaskExecutor.TaskResult
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clusterStateProcessed
(String source, ClusterState oldState, ClusterState newState) Called when the result of theClusterStateTaskExecutor.execute(ClusterState, List)
have been processed properly by all listeners.execute
(ClusterState currentState) Update the cluster state based on the current state.void
A callback for when task execution fails.void
submit
(ClusterService clusterService) Submit the update task so that it will actually be executed.static MigrationResultsUpdateTask
upsert
(String featureName, SingleFeatureMigrationResult status, ActionListener<ClusterState> listener) Creates a task that will update the status of a feature migration.Methods inherited from class org.elasticsearch.cluster.ClusterStateUpdateTask
clusterStatePublished, describeTasks, execute, priority, runOnlyOnMaster, timeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.cluster.ClusterStateTaskListener
onNoLongerMaster
-
Method Details
-
upsert
public static MigrationResultsUpdateTask upsert(String featureName, SingleFeatureMigrationResult status, ActionListener<ClusterState> listener) Creates a task that will update the status of a feature migration.- Parameters:
featureName
- The name of the feature whose status should be updated.status
- The status to be associated with the given feature.listener
- A listener that will be called upon successfully updating the cluster state.
-
submit
Submit the update task so that it will actually be executed.- Parameters:
clusterService
- The cluster service to which this task should be submitted.
-
execute
Description copied from class:ClusterStateUpdateTask
Update the cluster state based on the current state. Return the *same instance* if no state should be changed.- Specified by:
execute
in classClusterStateUpdateTask
- Throws:
Exception
-
clusterStateProcessed
Description copied from interface:ClusterStateTaskListener
Called when the result of theClusterStateTaskExecutor.execute(ClusterState, List)
have been processed properly by all listeners. Implementations of this callback must not throw exceptions: an exception thrown here is logged by the master service atERROR
level and otherwise ignored, except in tests where it raises anAssertionError
. If log-and-ignore is the right behaviour then implementations must do so themselves, typically using a more specific logger and at a less dramatic log level. -
onFailure
Description copied from class:ClusterStateUpdateTask
A callback for when task execution fails. Implementations of this callback should not throw exceptions: an exception thrown here is logged by the master service atERROR
level and otherwise ignored. If log-and-ignore is the right behaviour then implementations should do so themselves, typically using a more specific logger and at a less dramatic log level.- Specified by:
onFailure
in interfaceClusterStateTaskListener
- Specified by:
onFailure
in classClusterStateUpdateTask
-