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

63 lines
3.9 KiB
Plaintext

[[reference-ccr-follow_stats]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.ccr.followStats
Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.
{ref}/ccr-get-follow-stats.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(CcrFollowStatsRequest, options?): Promise<CcrFollowStatsResponse>
----
[discrete]
===== `CcrFollowStatsRequest`
[source,ts]
----
interface CcrFollowStatsRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
}
----
[discrete]
===== `CcrFollowStatsResponse`
[source,ts]
----
interface CcrFollowStatsResponse {
indices: CcrFollowIndexStats[]
}
----