New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« List Tasks API Script APIs »
Elastic Docs ›Java REST Client [6.4] ›Java High Level REST Client ›Tasks APIs

Cancel Tasks API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Cancel Tasks API

edit

The Cancel Tasks API allows cancellation of a currently running task.

Cancel Tasks Request

edit

A CancelTasksRequest:

CancelTasksRequest request = new CancelTasksRequest();

There are no required parameters. The task cancellation command supports the same task selection parameters as the list tasks command.

Parameters

edit
request.setActions("cluster:*"); 
request.setNodes("nodeId1", "nodeId2"); 
request.setParentTaskId(new TaskId("parentTaskId", 42));

Cancel a task

Cancel only cluster-related tasks

Cancel all tasks running on nodes nodeId1 and nodeId2

Synchronous Execution

edit
ListTasksResponse response = client.tasks().list(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution requires CancelTasksRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.tasks().cancelAsync(request, RequestOptions.DEFAULT, listener);

The CancelTasksRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed.

A typical listener for CancelTasksResponse looks like:

ActionListener<CancelTasksResponse> listener =
    new ActionListener<CancelTasksResponse>() {
        @Override
        public void onResponse(CancelTasksResponse response) {
            
        }
        @Override
        public void onFailure(Exception e) {
            
        }
    };

Called when the execution is successfully completed. The response is provided as an argument

Called in case of a failure. The raised exception is provided as an argument

Cancel Tasks Response

edit
List<TaskInfo> tasks = response.getTasks();

List of cancelled tasks

 
Map<String, List<TaskInfo>> perNodeTasks = response.getPerNodeTasks(); 
List<TaskGroup> groups = response.getTaskGroups();

List of cancelled tasks grouped by a node

List of cancelled tasks grouped by a parent task

 
List<ElasticsearchException> nodeFailures = response.getNodeFailures(); 
List<TaskOperationFailure> taskFailures = response.getTaskFailures();

List of node failures

List of task cancellation failures
« List Tasks API Script APIs »