76 lines
3.9 KiB
Plaintext
76 lines
3.9 KiB
Plaintext
[[reference-tasks-cancel]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
[[client.tasks.cancel]]
|
|
=== client.tasks.cancel
|
|
|
|
Cancels a task, if it can be cancelled through an API.
|
|
|
|
{ref}/tasks.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(TasksCancelRequest, options?): Promise<TasksCancelResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== TasksCancelRequest
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TasksCancelRequest extends <<RequestBase>> {
|
|
task_id?: <<TaskId>>
|
|
actions?: string | string[]
|
|
nodes?: string[]
|
|
parent_task_id?: string
|
|
wait_for_completion?: boolean
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== TasksCancelResponse
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
type TasksCancelResponse = <<TasksTaskListResponseBase>>
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|