elasticsearch/docs/reference/rollup/rollup-apis.asciidoc
2021-03-10 08:41:27 -05:00

85 lines
2.1 KiB
Text

[role="xpack"]
[testenv="basic"]
[[rollup-apis]]
== Rollup APIs
ifdef::permanently-unreleased-branch[]
A rollup aggregates an index's time series data and stores the results in
a new index. For example, you can roll up hourly data into daily or weekly
summaries.
* <<rollup-api,Rollup API>>
[discrete]
[[legacy-rollup-apis]]
=== Legacy rollup APIs
include::{es-repo-dir}/rollup/index.asciidoc[tag=legacy-rollups]
[discrete]
[[rollup-jobs-endpoint]]
==== Jobs
* <<rollup-put-job,Create>> or <<rollup-delete-job,delete legacy {rollup-jobs}>>
* <<rollup-start-job,Start>> or <<rollup-stop-job,stop legacy {rollup-jobs}>>
* <<rollup-get-job,Get legacy {rollup-jobs}>>
[discrete]
[[rollup-data-endpoint]]
==== Data
* <<rollup-get-rollup-caps,Get legacy rollup capabilities>>
* <<rollup-get-rollup-index-caps,Get legacy rollup index capabilities>>
[discrete]
[[rollup-search-endpoint]]
==== Search
* <<rollup-search,Legacy rollup search>>
include::apis/rollup-api.asciidoc[]
include::apis/put-job.asciidoc[]
include::apis/delete-job.asciidoc[]
include::apis/get-job.asciidoc[]
include::apis/rollup-caps.asciidoc[]
include::apis/rollup-index-caps.asciidoc[]
include::apis/rollup-search.asciidoc[]
include::apis/start-job.asciidoc[]
include::apis/stop-job.asciidoc[]
endif::[]
ifndef::permanently-unreleased-branch[]
[discrete]
[[rollup-jobs-endpoint]]
=== Jobs
* <<rollup-put-job,Create>> or <<rollup-delete-job,delete {rollup-jobs}>>
* <<rollup-start-job,Start>> or <<rollup-stop-job,stop {rollup-jobs}>>
* <<rollup-get-job,Get {rollup-jobs}>>
[discrete]
[[rollup-data-endpoint]]
=== Data
* <<rollup-get-rollup-caps,Get rollup capabilities>>
* <<rollup-get-rollup-index-caps,Get rollup index capabilities>>
[discrete]
[[rollup-search-endpoint]]
=== Search
* <<rollup-search,Rollup search>>
include::apis/put-job.asciidoc[]
include::apis/delete-job.asciidoc[]
include::apis/get-job.asciidoc[]
include::apis/rollup-caps.asciidoc[]
include::apis/rollup-index-caps.asciidoc[]
include::apis/rollup-search.asciidoc[]
include::apis/start-job.asciidoc[]
include::apis/stop-job.asciidoc[]
endif::[]