Skip to content

Commit

Permalink
[DOCS] Add experimental tag to rollup APIs (#63206)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Oct 5, 2020
1 parent 509507d commit cd38a51
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/java-rest/high-level/rollup/delete_job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="{upid}-{api}"]
=== Delete Rollup Job API

experimental::[]

[id="{upid}-{api}-request"]
==== Request
Expand Down
2 changes: 2 additions & 0 deletions docs/java-rest/high-level/rollup/get_job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
[[java-rest-high-x-pack-rollup-get-job]]
=== Get Rollup Job API

experimental::[]

The Get Rollup Job API can be used to get one or all rollup jobs from the
cluster. It accepts a `GetRollupJobRequest` object as a request and returns
a `GetRollupJobResponse`.
Expand Down
2 changes: 2 additions & 0 deletions docs/java-rest/high-level/rollup/get_rollup_caps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="{upid}-x-pack-{api}"]
=== Get Rollup Capabilities API

experimental::[]

The Get Rollup Capabilities API allows the user to query a target index pattern (`logstash-*`, etc)
and determine if there are any rollup jobs that are/were configured to rollup that pattern.
The API accepts a `GetRollupCapsRequest` object as a request and returns a `GetRollupCapsResponse`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="{upid}-x-pack-{api}"]
=== Get Rollup Index Capabilities API

experimental::[]

The Get Rollup Index Capabilities API allows the user to determine if a concrete index or index pattern contains
stored rollup jobs and data. If it contains data stored from rollup jobs, the capabilities of those jobs
are returned. The API accepts a `GetRollupIndexCapsRequest` object as a request and returns a `GetRollupIndexCapsResponse`.
Expand Down
2 changes: 2 additions & 0 deletions docs/java-rest/high-level/rollup/put_job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
[[java-rest-high-x-pack-rollup-put-job]]
=== Put Rollup Job API

experimental::[]

The Put Rollup Job API can be used to create a new Rollup job
in the cluster. The API accepts a `PutRollupJobRequest` object
as a request and returns a `PutRollupJobResponse`.
Expand Down
2 changes: 2 additions & 0 deletions docs/java-rest/high-level/rollup/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="{upid}-{api}"]
=== Rollup Search API

experimental::[]

The Rollup Search endpoint allows searching rolled-up data using the standard
query DSL. The Rollup Search endpoint is needed because, internally,
rolled-up documents utilize a different document structure than the original
Expand Down
2 changes: 2 additions & 0 deletions docs/java-rest/high-level/rollup/start_job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="{upid}-{api}"]
=== Start Rollup Job API

experimental::[]

[id="{upid}-{api}-request"]
==== Request

Expand Down
2 changes: 2 additions & 0 deletions docs/java-rest/high-level/rollup/stop_job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="{upid}-{api}"]
=== Stop Rollup Job API

experimental::[]

[id="{upid}-{api}-request"]
==== Request

Expand Down

0 comments on commit cd38a51

Please sign in to comment.