mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-10 15:05:33 +00:00
2fdbed7797
Today when canceling a task we broadcast ban/unban requests to all nodes in the cluster. This strategy does not scale well for hierarchical cancellation. With this change, we will track outstanding child requests and broadcast the cancellation to only nodes that have outstanding child tasks. This change also prevents a parent task from sending child requests once it got canceled. Relates #50990 Supersedes #51157 Co-authored-by: Igor Motov <igor@motovs.org> Co-authored-by: Yannick Welsch <yannick@welsch.lu>
85 lines
3.5 KiB
Plaintext
85 lines
3.5 KiB
Plaintext
[[java-rest-high-cluster-cancel-tasks]]
|
|
=== Cancel Tasks API
|
|
|
|
The Cancel Tasks API allows cancellation of a currently running task.
|
|
|
|
==== Cancel Tasks Request
|
|
|
|
A `CancelTasksRequest`:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-request]
|
|
--------------------------------------------------
|
|
There are no required parameters. The task cancellation command supports the same
|
|
task selection parameters as the list tasks command.
|
|
|
|
==== Parameters
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-request-filter]
|
|
--------------------------------------------------
|
|
<1> Cancel a task
|
|
<2> Cancel only cluster-related tasks
|
|
<3> Should the request block until the cancellation of the task and its child tasks is completed.
|
|
Otherwise, the request can return soon after the cancellation is started. Defaults to `false`.
|
|
<4> Cancel all tasks running on nodes nodeId1 and nodeId2
|
|
|
|
==== Synchronous Execution
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-execute]
|
|
--------------------------------------------------
|
|
|
|
==== Asynchronous Execution
|
|
|
|
The asynchronous execution requires `CancelTasksRequest` instance and an
|
|
`ActionListener` instance to be passed to the asynchronous method:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-execute-async]
|
|
--------------------------------------------------
|
|
<1> 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:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-execute-listener]
|
|
--------------------------------------------------
|
|
<1> Called when the execution is successfully completed. The response is
|
|
provided as an argument
|
|
<2> Called in case of a failure. The raised exception is provided as an argument
|
|
|
|
==== Cancel Tasks Response
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-response-tasks]
|
|
--------------------------------------------------
|
|
<1> List of cancelled tasks
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-response-calc]
|
|
--------------------------------------------------
|
|
<1> List of cancelled tasks grouped by a node
|
|
<2> List of cancelled tasks grouped by a parent task
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/TasksClientDocumentationIT.java[cancel-tasks-response-failures]
|
|
--------------------------------------------------
|
|
<1> List of node failures
|
|
<2> List of task cancellation failures
|
|
|