mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-09 06:25:07 +00:00
3a464bdee8
This change adds support for starting a rollup job to High Level REST Client. Relates to #29827
35 lines
888 B
Plaintext
35 lines
888 B
Plaintext
--
|
|
:api: rollup-start-job
|
|
:request: StartRollupJobRequest
|
|
:response: StartRollupJobResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Start Rollup Job API
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
The Start Rollup Job API allows you to start a job by ID.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> The ID of the job to start.
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ indicates if the start command was received.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> Whether or not the start job request was received.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|