Package org.elasticsearch.persistent

Class PersistentTasksExecutor<Params extends PersistentTaskParams>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.persistent.PersistentTasksExecutor<Params>

public abstract class PersistentTasksExecutor<Params extends PersistentTaskParams>
extends AbstractComponent

An executor of tasks that can survive restart of requesting or executing node. These tasks are using cluster state rather than only transport service to send requests and responses.

Field Summary

Fields

Modifier and Type	Field	Description
static PersistentTasksCustomMetaData.Assignment	NO_NODE_FOUND

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PersistentTasksExecutor(Settings settings, java.lang.String taskName, java.lang.String executor)

Method Summary

Modifier and Type	Method	Description
protected AllocatedPersistentTask	createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, PersistentTasksCustomMetaData.PersistentTask<Params> taskInProgress, java.util.Map<java.lang.String,java.lang.String> headers)	Creates a AllocatedPersistentTask for communicating with task manager
PersistentTasksCustomMetaData.Assignment	getAssignment(Params params, ClusterState clusterState)	Returns the node id where the params has to be executed,
protected java.lang.String	getDescription(PersistentTasksCustomMetaData.PersistentTask<Params> taskInProgress)	Returns task description that will be available via task manager
java.lang.String	getExecutor()
java.lang.String	getTaskName()
protected abstract void	nodeOperation(AllocatedPersistentTask task, Params params, Task.Status status)	This operation will be executed on the executor node.
protected DiscoveryNode	selectLeastLoadedNode(ClusterState clusterState, java.util.function.Predicate<DiscoveryNode> selector)	Finds the least loaded node that satisfies the selector criteria
void	validate(Params params, ClusterState clusterState)	Checks the current cluster state for compatibility with the params

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_NODE_FOUND

public static final PersistentTasksCustomMetaData.Assignment NO_NODE_FOUND

Constructor Detail

PersistentTasksExecutor

protected PersistentTasksExecutor(Settings settings,
                                  java.lang.String taskName,
                                  java.lang.String executor)

Method Detail

getTaskName

public java.lang.String getTaskName()

getAssignment

public PersistentTasksCustomMetaData.Assignment getAssignment(Params params,
                                                              ClusterState clusterState)

Returns the node id where the params has to be executed,

The default implementation returns the least loaded data node

selectLeastLoadedNode

protected DiscoveryNode selectLeastLoadedNode(ClusterState clusterState,
                                              java.util.function.Predicate<DiscoveryNode> selector)

Finds the least loaded node that satisfies the selector criteria

validate

public void validate(Params params,
                     ClusterState clusterState)

Checks the current cluster state for compatibility with the params

Throws an exception if the supplied params cannot be executed on the cluster in the current state.

createTask

protected AllocatedPersistentTask createTask(long id,
                                             java.lang.String type,
                                             java.lang.String action,
                                             TaskId parentTaskId,
                                             PersistentTasksCustomMetaData.PersistentTask<Params> taskInProgress,
                                             java.util.Map<java.lang.String,java.lang.String> headers)

Creates a AllocatedPersistentTask for communicating with task manager

getDescription

protected java.lang.String getDescription(PersistentTasksCustomMetaData.PersistentTask<Params> taskInProgress)

Returns task description that will be available via task manager

nodeOperation

protected abstract void nodeOperation(AllocatedPersistentTask task,
                                      Params params,
                                      @Nullable
                                      Task.Status status)

This operation will be executed on the executor node.

NOTE: The nodeOperation has to throw an exception, trigger task.markAsCompleted() or task.completeAndNotifyIfNeeded() methods to indicate that the persistent task has finished.

getExecutor

public java.lang.String getExecutor()