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

63 lines
3.8 KiB
Plaintext

[[reference-rollup-get_jobs]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.rollup.getJobs
Retrieves the configuration, stats, and status of rollup jobs.
{ref}/rollup-get-job.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(RollupGetJobsRequest, options?): Promise<RollupGetJobsResponse>
----
[discrete]
===== `RollupGetJobsRequest`
[source,ts]
----
interface RollupGetJobsRequest extends <<shared-type-request-base, RequestBase>> {
id?: <<shared-type-id, Id>>
}
----
[discrete]
===== `RollupGetJobsResponse`
[source,ts]
----
interface RollupGetJobsResponse {
jobs: RollupGetJobsRollupJob[]
}
----