Module org.elasticsearch.server
Package org.elasticsearch.cluster
Interface ClusterStateTaskExecutor<T extends ClusterStateTaskListener>
- Type Parameters:
T
- The type of tasks to execute.
- All Known Implementing Classes:
JoinTaskExecutor
,NodeRemovalClusterStateTaskExecutor
,ReservedStateUpdateTaskExecutor
,ShardStateAction.ShardFailedClusterStateTaskExecutor
,ShardStateAction.ShardStartedClusterStateTaskExecutor
public interface ClusterStateTaskExecutor<T extends ClusterStateTaskListener>
An executor for batches of cluster state update tasks.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final record
Encapsulates the context in which a batch of tasks executes.static interface
A task to be executed, along with callbacks for the executor to record the outcome of this task's execution. -
Method Summary
Modifier and TypeMethodDescriptiondefault void
clusterStatePublished
(ClusterState newClusterState) Callback invoked after new cluster state is published.default String
describeTasks
(List<T> tasks) Builds a concise description of a list of tasks (to be used in logging etc.).execute
(ClusterStateTaskExecutor.BatchExecutionContext<T> batchExecutionContext) Update the cluster state based on the current state and the given tasks.default boolean
-
Method Details
-
execute
ClusterState execute(ClusterStateTaskExecutor.BatchExecutionContext<T> batchExecutionContext) throws Exception Update the cluster state based on the current state and the given tasks. Return the *same instance* if no update should be published.If this method throws an exception then the cluster state is unchanged and every task's
ClusterStateTaskListener.onFailure(java.lang.Exception)
method is called.A common implementation pattern is to iterate through the tasks, constructing a new and updated
ClusterState
for each one. This works ok but beware that constructing a whole newClusterState
can be somewhat expensive, and there may sometimes be surprisingly many tasks to process in the batch. If it's possible to accumulate the effects of the tasks at a lower level then you should do that instead.- Returns:
- The resulting cluster state after executing all the tasks. If {code initialState} is returned then no update is published.
- Throws:
Exception
-
runOnlyOnMaster
default boolean runOnlyOnMaster()- Returns:
true
iff this executor should only run on the elected master.
-
clusterStatePublished
Callback invoked after new cluster state is published. Note that this method is not invoked if the cluster state was not updated. Note that this method will be executed using system context.- Parameters:
newClusterState
- The new state which was published.
-
describeTasks
Builds a concise description of a list of tasks (to be used in logging etc.). Note that the tasks given are not necessarily the same as those that will be passed toexecute(org.elasticsearch.cluster.ClusterStateTaskExecutor.BatchExecutionContext<T>)
but are guaranteed to be a subset of them. This method can be called multiple times with different lists before execution.- Parameters:
tasks
- the tasks to describe.- Returns:
- A string which describes the batch of tasks.
-