Module org.elasticsearch.server

Package org.elasticsearch.persistent

Class PersistentTasksService

java.lang.Object

org.elasticsearch.persistent.PersistentTasksService

public class PersistentTasksService
extends Object

This service is used by persistent tasks and allocated persistent tasks to communicate changes to the master node so that the master can update the cluster state and can track of the states of the persistent tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PersistentTasksService.WaitForPersistentTaskListener<P extends PersistentTaskParams>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PERSISTENT_TASK_ORIGIN

Constructor Summary

Constructors

Constructor	Description
PersistentTasksService(ClusterService clusterService, ThreadPool threadPool, Client client)

Method Summary

Modifier and Type	Method	Description
void	sendClusterCompletionRequest(String taskId, long taskAllocationId, Exception taskFailure, String localAbortReason, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)	Notifies the master node about the completion of a persistent task.
void	sendClusterRemoveRequest(String taskId, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)	Notifies the master node to remove a persistent task from the cluster state.
<Params extends PersistentTaskParams> void	sendClusterStartRequest(String taskId, String taskName, Params taskParams, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<Params>> listener)	Notifies the master node to create new cluster persistent task and to assign it to a node.
void	sendCompletionRequest(String taskId, long taskAllocationId, Exception taskFailure, String localAbortReason, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)	Deprecated, for removal: This API element is subject to removal in a future version.
void	sendProjectCompletionRequest(ProjectId projectId, String taskId, long taskAllocationId, Exception taskFailure, String localAbortReason, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)	Notifies the master node about the completion of a project level persistent task.
void	sendProjectRemoveRequest(ProjectId projectId, String taskId, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)	Notifies the master node to remove a project level persistent task from the cluster state.
<Params extends PersistentTaskParams> void	sendProjectStartRequest(ProjectId projectId, String taskId, String taskName, Params taskParams, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<Params>> listener)	Notifies the master node to create new project level persistent task and to assign it to a node.
void	sendRemoveRequest(String taskId, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)	Notifies the master node to remove a persistent task from the cluster state.
<Params extends PersistentTaskParams> void	sendStartRequest(String taskId, String taskName, Params taskParams, TimeValue timeout, ActionListener<PersistentTasksCustomMetadata.PersistentTask<Params>> listener)	Deprecated, for removal: This API element is subject to removal in a future version.
void	waitForPersistentTaskCondition(String taskId, Predicate<PersistentTasksCustomMetadata.PersistentTask<?>> predicate, TimeValue timeout, PersistentTasksService.WaitForPersistentTaskListener<?> listener)	Deprecated, for removal: This API element is subject to removal in a future version.
void	waitForPersistentTaskCondition(ProjectId projectId, String taskId, Predicate<PersistentTasksCustomMetadata.PersistentTask<?>> predicate, TimeValue timeout, PersistentTasksService.WaitForPersistentTaskListener<?> listener)	Waits for a given persistent task to comply with a given predicate, then call back the listener accordingly.
void	waitForPersistentTasksCondition(ProjectId projectId, Predicate<PersistentTasksCustomMetadata> predicate, TimeValue timeout, ActionListener<Boolean> listener)	Waits for persistent tasks to comply with a given predicate, then call back the listener accordingly.

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENT_TASK_ORIGIN

public static final String PERSISTENT_TASK_ORIGIN

See Also:

• Constant Field Values

Constructor Details

PersistentTasksService

public PersistentTasksService(ClusterService clusterService,
 ThreadPool threadPool,
 Client client)

Method Details

sendStartRequest

@Deprecated(forRemoval=true)
public <Params extends PersistentTaskParams> void sendStartRequest(String taskId,
 String taskName,
 Params taskParams,
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<Params>> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Notifies the master node to create new persistent task and to assign it to a node. Accepts operation timeout as optional parameter

sendClusterStartRequest

public <Params extends PersistentTaskParams> void sendClusterStartRequest(String taskId,
 String taskName,
 Params taskParams,
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<Params>> listener)

Notifies the master node to create new cluster persistent task and to assign it to a node. Accepts operation timeout as optional parameter

sendProjectStartRequest

public <Params extends PersistentTaskParams> void sendProjectStartRequest(ProjectId projectId,
 String taskId,
 String taskName,
 Params taskParams,
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<Params>> listener)

Notifies the master node to create new project level persistent task and to assign it to a node. Accepts operation timeout as optional parameter

sendCompletionRequest

@Deprecated(forRemoval=true)
public void sendCompletionRequest(String taskId,
 long taskAllocationId,
 @Nullable
 Exception taskFailure,
 @Nullable
 String localAbortReason,
 @Nullable
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Notifies the master node about the completion of a persistent task.

At most one of failure and localAbortReason may be provided. When both failure and localAbortReason are null, the persistent task is considered as successfully completed. Accepts operation timeout as optional parameter

sendClusterCompletionRequest

public void sendClusterCompletionRequest(String taskId,
 long taskAllocationId,
 @Nullable
 Exception taskFailure,
 @Nullable
 String localAbortReason,
 @Nullable
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)

Notifies the master node about the completion of a persistent task.

At most one of failure and localAbortReason may be provided. When both failure and localAbortReason are null, the persistent task is considered as successfully completed. Accepts operation timeout as optional parameter

sendProjectCompletionRequest

public void sendProjectCompletionRequest(ProjectId projectId,
 String taskId,
 long taskAllocationId,
 @Nullable
 Exception taskFailure,
 @Nullable
 String localAbortReason,
 @Nullable
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)

Notifies the master node about the completion of a project level persistent task.

At most one of failure and localAbortReason may be provided. When both failure and localAbortReason are null, the persistent task is considered as successfully completed. Accepts operation timeout as optional parameter

sendRemoveRequest

public void sendRemoveRequest(String taskId,
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)

Notifies the master node to remove a persistent task from the cluster state. Accepts operation timeout as optional parameter

sendClusterRemoveRequest

public void sendClusterRemoveRequest(String taskId,
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)

Notifies the master node to remove a persistent task from the cluster state. Accepts operation timeout as optional parameter

sendProjectRemoveRequest

public void sendProjectRemoveRequest(ProjectId projectId,
 String taskId,
 TimeValue timeout,
 ActionListener<PersistentTasksCustomMetadata.PersistentTask<?>> listener)

Notifies the master node to remove a project level persistent task from the cluster state. Accepts operation timeout as optional parameter

waitForPersistentTaskCondition

@Deprecated(forRemoval=true)
public void waitForPersistentTaskCondition(String taskId,
 Predicate<PersistentTasksCustomMetadata.PersistentTask<?>> predicate,
 @Nullable
 TimeValue timeout,
 PersistentTasksService.WaitForPersistentTaskListener<?> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Waits for a given persistent task to comply with a given predicate, then call back the listener accordingly.

Parameters:

taskId - the persistent task id

predicate - the persistent task predicate to evaluate

timeout - a timeout for waiting

listener - the callback listener

waitForPersistentTaskCondition

public void waitForPersistentTaskCondition(ProjectId projectId,
 String taskId,
 Predicate<PersistentTasksCustomMetadata.PersistentTask<?>> predicate,
 @Nullable
 TimeValue timeout,
 PersistentTasksService.WaitForPersistentTaskListener<?> listener)

Waits for a given persistent task to comply with a given predicate, then call back the listener accordingly.

Parameters:

projectId - the project ID

taskId - the persistent task id

predicate - the persistent task predicate to evaluate, must be able to handle null input which means either the project does not exist or persistent tasks for the project do not exist

timeout - a timeout for waiting

listener - the callback listener

waitForPersistentTasksCondition

public void waitForPersistentTasksCondition(ProjectId projectId,
 Predicate<PersistentTasksCustomMetadata> predicate,
 @Nullable
 TimeValue timeout,
 ActionListener<Boolean> listener)

Waits for persistent tasks to comply with a given predicate, then call back the listener accordingly.

Parameters:

projectId - the project that the persistent tasks are associated with

predicate - the predicate to evaluate, must be able to handle null input which means either the project does not exist or persistent tasks for the project do not exist

timeout - a timeout for waiting

listener - the callback listener