Files
elasticsearch-js/docs/reference/reindex_rethrottle.asciidoc
2024-12-05 14:47:47 -06:00

77 lines
4.1 KiB
Plaintext

[[reference-reindex_rethrottle]]
== client.reindexRethrottle
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.reindexRethrottle]]
== `client.reindexRethrottle()`
Throttle a reindex operation. Change the number of requests per second for a particular reindex operation.
{ref}/docs-reindex.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ReindexRethrottleRequest, options?: TransportRequestOptions) => Promise<ReindexRethrottleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ReindexRethrottleRequest extends <<RequestBase>> {
task_id: <<Id>>
requests_per_second?: <<float>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ReindexRethrottleResponse {
nodes: Record<string, <<ReindexRethrottleReindexNode>>>
}
----