Test run of new docs
This commit is contained in:
67
docs/reference-tasks-list.asciidoc
Normal file
67
docs/reference-tasks-list.asciidoc
Normal file
@ -0,0 +1,67 @@
|
||||
[[reference-tasks-list]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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.list
|
||||
|
||||
The task management API returns information about tasks currently executing on one or more nodes in the cluster.
|
||||
|
||||
{ref}/tasks.html[{es} documentation]
|
||||
|
||||
[discrete]
|
||||
==== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(TasksListRequest, options?): Promise<TasksListResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `TasksListRequest`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
interface TasksListRequest extends <<shared-type-request-base, RequestBase>> {
|
||||
actions?: string | string[]
|
||||
detailed?: boolean
|
||||
group_by?: TasksGroupBy
|
||||
nodes?: <<shared-type-node-ids, NodeIds>>
|
||||
parent_task_id?: <<shared-type-id, Id>>
|
||||
master_timeout?: <<shared-type-duration, Duration>>
|
||||
timeout?: <<shared-type-duration, Duration>>
|
||||
wait_for_completion?: boolean
|
||||
}
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `TasksListResponse`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
type TasksListResponse = TasksTaskListResponseBase
|
||||
----
|
||||
|
||||
Reference in New Issue
Block a user