habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/reference-delete_by_query_rethrottle.asciidoc Normal file
View File

@ -0,0 +1,61 @@
[[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 <<shared-type-request-base, RequestBase>> {
task_id: <<shared-type-task-id, TaskId>>
requests_per_second?: <<shared-type-float, float>>
}
----
[discrete]
===== `DeleteByQueryRethrottleResponse`
[source,ts]
----
type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
----