honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/rollup/stop_job.asciidoc

40 lines
1.1 KiB
Plaintext
Raw Normal View History

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
2018-11-13 23:40:42 -05:00
--
: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.
HLRC: Add parameters to stopRollupJob API (#35545) With #34811 the API for stopping rollup jobs got two new url parameters "wait_for_completion" and "timeout". This change adds these to the HLRC APIs as well. Relates to #34811
2018-11-15 04:50:48 -05:00
<2> Whether the request should wait that the stop operation has completed
before returning (optional, defaults to `false`)
<3> If `wait_for_completion=true`, this parameter controls how long to wait
before giving up and throwing an error (optional, defaults to 30 seconds).
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
2018-11-13 23:40:42 -05:00
[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[]