62 lines
4.1 KiB
Plaintext
62 lines
4.1 KiB
Plaintext
[[reference-delete_by_query_rethrottle]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.deleteByQueryRethrottle
|
|
|
|
Throttle a delete by query operation. Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
|
|
|
|
{ref}/docs-delete-by-query.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(DeleteByQueryRethrottleRequest, options?): Promise<DeleteByQueryRethrottleResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `DeleteByQueryRethrottleRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface DeleteByQueryRethrottleRequest extends <<RequestBase>> {
|
|
task_id: <<TaskId>>
|
|
requests_per_second?: <<float>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `DeleteByQueryRethrottleResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
|
|
----
|
|
|