Package org.elasticsearch.persistent

Class PersistentTasksService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.persistent.PersistentTasksService

public class PersistentTasksService
extends AbstractComponent

This service is used by persistent actions to propagate changes in the action state and notify about completion

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PersistentTasksService.WaitForPersistentTaskStatusListener<Params extends PersistentTaskParams>

Field Summary

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	cancelPersistentTask(java.lang.String taskId, ActionListener<PersistentTasksCustomMetaData.PersistentTask<?>> listener)	Cancels if needed and removes a persistent task
static <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void	executeAsyncWithOrigin(Client client, java.lang.String origin, Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener)	Executes an asynchronous action using the provided client.
static <Request extends ActionRequest,Response extends ActionResponse> void	executeAsyncWithOrigin(ThreadContext threadContext, java.lang.String origin, Request request, ActionListener<Response> listener, java.util.function.BiConsumer<Request,ActionListener<Response>> consumer)	Executes a consumer after setting the origin and wrapping the listener so that the proper context is restored
void	sendCompletionNotification(java.lang.String taskId, long allocationId, java.lang.Exception failure, ActionListener<PersistentTasksCustomMetaData.PersistentTask<?>> listener)	Notifies the PersistentTasksClusterService about successful (failure == null) completion of a task or its failure
<Params extends PersistentTaskParams> void	startPersistentTask(java.lang.String taskId, java.lang.String taskName, Params params, ActionListener<PersistentTasksCustomMetaData.PersistentTask<Params>> listener)	Creates the specified persistent task and attempts to assign it to a node.
static ThreadContext.StoredContext	stashWithOrigin(ThreadContext threadContext, java.lang.String origin)
void	waitForPersistentTasksStatus(java.util.function.Predicate<PersistentTasksCustomMetaData> predicate, TimeValue timeout, ActionListener<java.lang.Boolean> listener)
void	waitForPersistentTaskStatus(java.lang.String taskId, java.util.function.Predicate<PersistentTasksCustomMetaData.PersistentTask<?>> predicate, TimeValue timeout, PersistentTasksService.WaitForPersistentTaskStatusListener<?> listener)	Checks if the persistent task with giving id (taskId) has the desired state and if it doesn't waits of it.

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

Constructor Detail

PersistentTasksService

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

Method Detail

startPersistentTask

public <Params extends PersistentTaskParams> void startPersistentTask(java.lang.String taskId,
                                                                      java.lang.String taskName,
                                                                      Params params,
                                                                      ActionListener<PersistentTasksCustomMetaData.PersistentTask<Params>> listener)

Creates the specified persistent task and attempts to assign it to a node.

sendCompletionNotification

public void sendCompletionNotification(java.lang.String taskId,
                                       long allocationId,
                                       java.lang.Exception failure,
                                       ActionListener<PersistentTasksCustomMetaData.PersistentTask<?>> listener)

Notifies the PersistentTasksClusterService about successful (failure == null) completion of a task or its failure

cancelPersistentTask

public void cancelPersistentTask(java.lang.String taskId,
                                 ActionListener<PersistentTasksCustomMetaData.PersistentTask<?>> listener)

Cancels if needed and removes a persistent task

waitForPersistentTaskStatus

public void waitForPersistentTaskStatus(java.lang.String taskId,
                                        java.util.function.Predicate<PersistentTasksCustomMetaData.PersistentTask<?>> predicate,
                                        @Nullable
                                        TimeValue timeout,
                                        PersistentTasksService.WaitForPersistentTaskStatusListener<?> listener)

Checks if the persistent task with giving id (taskId) has the desired state and if it doesn't waits of it.

waitForPersistentTasksStatus

public void waitForPersistentTasksStatus(java.util.function.Predicate<PersistentTasksCustomMetaData> predicate,
                                         @Nullable
                                         TimeValue timeout,
                                         ActionListener<java.lang.Boolean> listener)

executeAsyncWithOrigin

public static <Request extends ActionRequest,Response extends ActionResponse> void executeAsyncWithOrigin(ThreadContext threadContext,
                                                                                                          java.lang.String origin,
                                                                                                          Request request,
                                                                                                          ActionListener<Response> listener,
                                                                                                          java.util.function.BiConsumer<Request,ActionListener<Response>> consumer)

Executes a consumer after setting the origin and wrapping the listener so that the proper context is restored

executeAsyncWithOrigin

public static <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void executeAsyncWithOrigin(Client client,
                                                                                                                                                                                       java.lang.String origin,
                                                                                                                                                                                       Action<Request,Response,RequestBuilder> action,
                                                                                                                                                                                       Request request,
                                                                                                                                                                                       ActionListener<Response> listener)

Executes an asynchronous action using the provided client. The origin is set in the context and the listener is wrapped to ensure the proper context is restored

stashWithOrigin

public static ThreadContext.StoredContext stashWithOrigin(ThreadContext threadContext,
                                                          java.lang.String origin)