Files
elasticsearch-js/docs/reference-cluster-pending_tasks.asciidoc
2024-12-05 14:46:46 -06:00

64 lines
4.4 KiB
Plaintext

[[reference-cluster-pending_tasks]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.cluster.pendingTasks
Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.
{ref}/cluster-pending.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ClusterPendingTasksRequest, options?): Promise<ClusterPendingTasksResponse>
----
[discrete]
===== `ClusterPendingTasksRequest`
[source,ts]
----
interface ClusterPendingTasksRequest extends <<shared-type-request-base, RequestBase>> {
local?: boolean
master_timeout?: <<shared-type-duration, Duration>>
}
----
[discrete]
===== `ClusterPendingTasksResponse`
[source,ts]
----
interface ClusterPendingTasksResponse {
tasks: ClusterPendingTasksPendingTask[]
}
----