68 lines
4.2 KiB
Plaintext
68 lines
4.2 KiB
Plaintext
[[reference-fleet-global_checkpoints]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.fleet.globalCheckpoints
|
|
|
|
Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
|
|
|
|
{ref}/get-global-checkpoints.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(FleetGlobalCheckpointsRequest, options?): Promise<FleetGlobalCheckpointsResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `FleetGlobalCheckpointsRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface FleetGlobalCheckpointsRequest extends <<shared-type-request-base, RequestBase>> {
|
|
index: <<shared-type-index-name, IndexName>> | <<shared-type-index-alias, IndexAlias>>
|
|
wait_for_advance?: boolean
|
|
wait_for_index?: boolean
|
|
checkpoints?: FleetCheckpoint[]
|
|
timeout?: <<shared-type-duration, Duration>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `FleetGlobalCheckpointsResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface FleetGlobalCheckpointsResponse {
|
|
global_checkpoints: FleetCheckpoint[]
|
|
timed_out: boolean
|
|
}
|
|
----
|
|
|