Module org.elasticsearch.server
Class TransportCancelTasksAction
java.lang.Object
org.elasticsearch.action.support.TransportAction<CancelTasksRequest,ListTasksResponse>
org.elasticsearch.action.support.HandledTransportAction<CancelTasksRequest,ListTasksResponse>
org.elasticsearch.action.support.tasks.TransportTasksAction<CancellableTask,CancelTasksRequest,ListTasksResponse,TaskInfo>
org.elasticsearch.action.admin.cluster.node.tasks.cancel.TransportCancelTasksAction
public class TransportCancelTasksAction
extends TransportTasksAction<CancellableTask,CancelTasksRequest,ListTasksResponse,TaskInfo>
Transport action that can be used to cancel currently running cancellable tasks.
For a task to be cancellable it has to return an instance of
CancellableTask from TaskAwareRequest.createTask(long, java.lang.String, java.lang.String, org.elasticsearch.tasks.TaskId, java.util.Map<java.lang.String, java.lang.String>)
-
Field Summary
FieldsFields inherited from class org.elasticsearch.action.support.tasks.TransportTasksAction
clusterService, requestReader, responseReader, transportNodeAction, transportServiceFields inherited from class org.elasticsearch.action.support.TransportAction
actionName, logger, taskManager -
Constructor Summary
ConstructorsConstructorDescriptionTransportCancelTasksAction(ClusterService clusterService, TransportService transportService, ActionFilters actionFilters) -
Method Summary
Modifier and TypeMethodDescriptionprotected ListTasksResponsenewResponse(CancelTasksRequest request, List<TaskInfo> tasks, List<TaskOperationFailure> taskOperationFailures, List<FailedNodeException> failedNodeExceptions) protected List<CancellableTask> processTasks(CancelTasksRequest request) protected voidtaskOperation(CancellableTask actionTask, CancelTasksRequest request, CancellableTask cancellableTask, ActionListener<TaskInfo> listener) Perform the required operation on the task.Methods inherited from class org.elasticsearch.action.support.tasks.TransportTasksAction
doExecute, processTasks, resolveNodesMethods inherited from class org.elasticsearch.action.support.TransportAction
execute, executeDirect, localOnly
-
Field Details
-
NAME
- See Also:
-
TYPE
-
-
Constructor Details
-
TransportCancelTasksAction
@Inject public TransportCancelTasksAction(ClusterService clusterService, TransportService transportService, ActionFilters actionFilters)
-
-
Method Details
-
newResponse
protected ListTasksResponse newResponse(CancelTasksRequest request, List<TaskInfo> tasks, List<TaskOperationFailure> taskOperationFailures, List<FailedNodeException> failedNodeExceptions) - Specified by:
newResponsein classTransportTasksAction<CancellableTask,CancelTasksRequest, ListTasksResponse, TaskInfo>
-
processTasks
- Overrides:
processTasksin classTransportTasksAction<CancellableTask,CancelTasksRequest, ListTasksResponse, TaskInfo>
-
taskOperation
protected void taskOperation(CancellableTask actionTask, CancelTasksRequest request, CancellableTask cancellableTask, ActionListener<TaskInfo> listener) Description copied from class:TransportTasksActionPerform the required operation on the task. It is OK start an asynchronous operation or to throw an exception but not both.- Specified by:
taskOperationin classTransportTasksAction<CancellableTask,CancelTasksRequest, ListTasksResponse, TaskInfo> - Parameters:
actionTask- The related transport action task. Can be used to create a task ID to handle upstream transport cancellations.request- the original transport requestcancellableTask- the task on which the operation is taking placelistener- the listener to signal.
-