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

65 lines
4.0 KiB
Plaintext

[[reference-searchable_snapshots-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.searchableSnapshots.stats
Retrieve shard-level statistics about searchable snapshots.
{ref}/searchable-snapshots-apis.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SearchableSnapshotsStatsRequest, options?): Promise<SearchableSnapshotsStatsResponse>
----
[discrete]
===== `SearchableSnapshotsStatsRequest`
[source,ts]
----
interface SearchableSnapshotsStatsRequest extends <<shared-type-request-base, RequestBase>> {
index?: <<shared-type-indices, Indices>>
level?: SearchableSnapshotsStatsLevel
}
----
[discrete]
===== `SearchableSnapshotsStatsResponse`
[source,ts]
----
interface SearchableSnapshotsStatsResponse {
stats: any
total: any
}
----