Files
elasticsearch-js/docs/reference-shared-types-tasks-types.asciidoc
2024-12-05 14:46:52 -06:00

148 lines
5.2 KiB
Plaintext

[[reference-shared-types-tasks-types]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
== Shared Tasks types
[discrete]
[[TasksGroupBy]]
=== TasksGroupBy
[pass]
++++
<pre>
++++
type TasksGroupBy = 'nodes' | 'parents' | 'none'
[pass]
++++
</pre>
++++
[discrete]
[[TasksNodeTasks]]
=== TasksNodeTasks
[pass]
++++
<pre>
++++
interface TasksNodeTasks {
name?: <<NodeId>>
transport_address?: <<TransportAddress>>
host?: <<Host>>
ip?: <<Ip>>
roles?: string[]
attributes?: Record<string, string>
tasks: Record<<<TaskId>>, <<TasksTaskInfo>>>
}
[pass]
++++
</pre>
++++
[discrete]
[[TasksParentTaskInfo]]
=== TasksParentTaskInfo
[pass]
++++
<pre>
++++
interface TasksParentTaskInfo extends <<TasksTaskInfo>> {
children?: <<TasksTaskInfo>>[]
}
[pass]
++++
</pre>
++++
[discrete]
[[TasksTaskInfo]]
=== TasksTaskInfo
[pass]
++++
<pre>
++++
interface TasksTaskInfo {
action: string
cancelled?: boolean
cancellable: boolean
description?: string
headers: Record<string, string>
id: <<long>>
node: <<NodeId>>
running_time?: <<Duration>>
running_time_in_nanos: <<DurationValue>><<<UnitNanos>>>
start_time_in_millis: <<EpochTime>><<<UnitMillis>>>
pass:[/**] @property status Task status information can vary wildly from task to task. */
status?: any
type: string
parent_task_id?: <<TaskId>>
}
[pass]
++++
</pre>
++++
[discrete]
[[TasksTaskInfos]]
=== TasksTaskInfos
[pass]
++++
<pre>
++++
type TasksTaskInfos = <<TasksTaskInfo>>[] | Record<string, <<TasksParentTaskInfo>>>
[pass]
++++
</pre>
++++
[discrete]
[[TasksTaskListResponseBase]]
=== TasksTaskListResponseBase
[pass]
++++
<pre>
++++
interface TasksTaskListResponseBase {
node_failures?: <<ErrorCause>>[]
task_failures?: <<TaskFailure>>[]
pass:[/**] @property nodes Task information grouped by node, if `group_by` was set to `node` (the default). */
nodes?: Record<string, <<TasksNodeTasks>>>
pass:[/**] @property tasks Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if `group_by` was set to `parents`. */
tasks?: <<TasksTaskInfos>>
}
[pass]
++++
</pre>
++++