Class TransportCancelTasksAction
- java.lang.Object
-
- org.elasticsearch.common.component.AbstractComponent
-
- org.elasticsearch.action.support.TransportAction<Request,Response>
-
- org.elasticsearch.action.support.HandledTransportAction<TasksRequest,TasksResponse>
-
- org.elasticsearch.action.support.tasks.TransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>
-
- org.elasticsearch.action.admin.cluster.node.tasks.cancel.TransportCancelTasksAction
-
public class TransportCancelTasksAction extends TransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,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
fromTaskAwareRequest.createTask(long, java.lang.String, java.lang.String, org.elasticsearch.tasks.TaskId, java.util.Map<java.lang.String, java.lang.String>)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.action.support.HandledTransportAction
HandledTransportAction.ChannelActionListener<Response extends TransportResponse,Request extends TransportRequest>
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
BAN_PARENT_ACTION_NAME
-
Fields inherited from class org.elasticsearch.action.support.tasks.TransportTasksAction
clusterService, requestSupplier, responseSupplier, transportNodeAction, transportService
-
Fields inherited from class org.elasticsearch.action.support.TransportAction
actionName, taskManager
-
Fields inherited from class org.elasticsearch.common.component.AbstractComponent
logger
-
-
Constructor Summary
Constructors Constructor Description TransportCancelTasksAction(ClusterService clusterService, TransportService transportService, ActionFilters actionFilters)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CancelTasksResponse
newResponse(CancelTasksRequest request, java.util.List<TaskInfo> tasks, java.util.List<TaskOperationFailure> taskOperationFailures, java.util.List<FailedNodeException> failedNodeExceptions)
protected void
processTasks(CancelTasksRequest request, java.util.function.Consumer<CancellableTask> operation)
protected TaskInfo
readTaskResponse(StreamInput in)
protected void
taskOperation(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, filterNodeIds, newResponse, resolveNodes, transportCompress
-
Methods inherited from class org.elasticsearch.action.support.TransportAction
execute, execute, execute
-
-
-
-
Field Detail
-
BAN_PARENT_ACTION_NAME
public static final java.lang.String BAN_PARENT_ACTION_NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TransportCancelTasksAction
@Inject public TransportCancelTasksAction(ClusterService clusterService, TransportService transportService, ActionFilters actionFilters)
-
-
Method Detail
-
newResponse
protected CancelTasksResponse newResponse(CancelTasksRequest request, java.util.List<TaskInfo> tasks, java.util.List<TaskOperationFailure> taskOperationFailures, java.util.List<FailedNodeException> failedNodeExceptions)
- Specified by:
newResponse
in classTransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>
-
readTaskResponse
protected TaskInfo readTaskResponse(StreamInput in) throws java.io.IOException
- Specified by:
readTaskResponse
in classTransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>
- Throws:
java.io.IOException
-
processTasks
protected void processTasks(CancelTasksRequest request, java.util.function.Consumer<CancellableTask> operation)
- Overrides:
processTasks
in classTransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>
-
taskOperation
protected void taskOperation(CancelTasksRequest request, CancellableTask cancellableTask, ActionListener<TaskInfo> listener)
Description copied from class:TransportTasksAction
Perform the required operation on the task. It is OK start an asynchronous operation or to throw an exception but not both.- Specified by:
taskOperation
in classTransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>
-
-