mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
Add stop rollup job support to HL REST Client (#34702)
This change adds support for stoping a rollup job to the High Level REST Client. Relates to #29827
This commit is contained in:
parent
c346a0f027
commit
603d1a470f
12 changed files with 351 additions and 22 deletions
34
docs/java-rest/high-level/rollup/stop_job.asciidoc
Normal file
34
docs/java-rest/high-level/rollup/stop_job.asciidoc
Normal file
|
@ -0,0 +1,34 @@
|
|||
--
|
||||
:api: rollup-stop-job
|
||||
:request: StopRollupJobRequest
|
||||
:response: StopRollupJobResponse
|
||||
--
|
||||
|
||||
[id="{upid}-{api}"]
|
||||
=== Stop Rollup Job API
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Request
|
||||
|
||||
The Stop Rollup Job API allows you to stop a job by ID.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> The ID of the job to stop.
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Response
|
||||
|
||||
The returned +{response}+ indicates if the stop command was received.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> Whether or not the stop job request was received.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
|
|
@ -316,6 +316,7 @@ The Java High Level REST Client supports the following Rollup APIs:
|
|||
|
||||
* <<java-rest-high-x-pack-rollup-put-job>>
|
||||
* <<{upid}-rollup-start-job>>
|
||||
* <<{upid}-rollup-stop-job>>
|
||||
* <<{upid}-rollup-delete-job>>
|
||||
* <<java-rest-high-x-pack-rollup-get-job>>
|
||||
* <<{upid}-x-pack-rollup-get-rollup-caps>>
|
||||
|
@ -323,6 +324,7 @@ The Java High Level REST Client supports the following Rollup APIs:
|
|||
|
||||
include::rollup/put_job.asciidoc[]
|
||||
include::rollup/start_job.asciidoc[]
|
||||
include::rollup/stop_job.asciidoc[]
|
||||
include::rollup/delete_job.asciidoc[]
|
||||
include::rollup/get_job.asciidoc[]
|
||||
include::rollup/get_rollup_caps.asciidoc[]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue