org.elasticsearch.action.admin.cluster.node.tasks.cancel

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 from TaskAwareRequest.createTask(long, String, String, TaskId)

Field Summary

Fields

Modifier and Type	Field and 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, indexNameExpressionResolver, taskManager, threadPool

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
TransportCancelTasksAction(Settings settings, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver)

Method Summary

Modifier and Type	Method and 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, doExecute, filterNodeIds, newResponse, resolveNodes, transportCompress

Methods inherited from class org.elasticsearch.action.support.TransportAction

execute, execute, execute, execute

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

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(Settings settings,
                                          ThreadPool threadPool,
                                          ClusterService clusterService,
                                          TransportService transportService,
                                          ActionFilters actionFilters,
                                          IndexNameExpressionResolver indexNameExpressionResolver)

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 class TransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>

readTaskResponse

protected TaskInfo readTaskResponse(StreamInput in)
                             throws java.io.IOException

Specified by:

readTaskResponse in class TransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>

Throws:

java.io.IOException

processTasks

protected void processTasks(CancelTasksRequest request,
                            java.util.function.Consumer<CancellableTask> operation)

Overrides:

processTasks in class TransportTasksAction<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 class TransportTasksAction<CancellableTask,CancelTasksRequest,CancelTasksResponse,TaskInfo>