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

80 lines
4.0 KiB
Plaintext

[[reference-rollup-put_job]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.putJob]]
=== client.rollup.putJob
Creates a rollup job.
{ref}/rollup-put-job.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(RollupPutJobRequest, options?): Promise<RollupPutJobResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface RollupPutJobRequest extends <<RequestBase>> {
id: <<Id>>
cron: string
groups: <<RollupGroupings>>
index_pattern: string
metrics?: <<RollupFieldMetric>>[]
page_size: <<integer>>
rollup_index: <<IndexName>>
timeout?: <<Duration>>
headers?: <<HttpHeaders>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
type RollupPutJobResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++