mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
bc5b1afb55
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
40 lines
1.1 KiB
Plaintext
40 lines
1.1 KiB
Plaintext
--
|
|
: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.
|
|
<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).
|
|
|
|
|
|
[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[]
|
|
|
|
|