Test run of new docs
This commit is contained in:
67
docs/reference-tasks-get.asciidoc
Normal file
67
docs/reference-tasks-get.asciidoc
Normal file
@ -0,0 +1,67 @@
|
||||
[[reference-tasks-get]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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.get
|
||||
|
||||
Get task information. Returns information about the tasks currently executing in the cluster.
|
||||
|
||||
{ref}/tasks.html[{es} documentation]
|
||||
|
||||
[discrete]
|
||||
==== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(TasksGetRequest, options?): Promise<TasksGetResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `TasksGetRequest`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
interface TasksGetRequest extends <<shared-type-request-base, RequestBase>> {
|
||||
task_id: <<shared-type-id, Id>>
|
||||
timeout?: <<shared-type-duration, Duration>>
|
||||
wait_for_completion?: boolean
|
||||
}
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `TasksGetResponse`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
interface TasksGetResponse {
|
||||
completed: boolean
|
||||
task: TasksTaskInfo
|
||||
response?: any
|
||||
error?: <<shared-type-error-cause, ErrorCause>>
|
||||
}
|
||||
----
|
||||
|
||||
Reference in New Issue
Block a user