64 lines
3.9 KiB
Plaintext
64 lines
3.9 KiB
Plaintext
[[reference-clear_scroll]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.clearScroll
|
|
|
|
Clear a scrolling search. Clear the search context and results for a scrolling search.
|
|
|
|
{ref}/clear-scroll-api.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(ClearScrollRequest, options?): Promise<ClearScrollResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `ClearScrollRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface ClearScrollRequest extends <<shared-type-request-base, RequestBase>> {
|
|
scroll_id?: <<shared-type-scroll-ids, ScrollIds>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `ClearScrollResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface ClearScrollResponse {
|
|
succeeded: boolean
|
|
num_freed: <<shared-type-integer, integer>>
|
|
}
|
|
----
|
|
|