stop_job.asciidoc 879 B

12345678910111213141516171819202122232425262728293031323334
  1. --
  2. :api: rollup-stop-job
  3. :request: StopRollupJobRequest
  4. :response: StopRollupJobResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Stop Rollup Job API
  8. [id="{upid}-{api}-request"]
  9. ==== Request
  10. The Stop Rollup Job API allows you to stop a job by ID.
  11. ["source","java",subs="attributes,callouts,macros"]
  12. --------------------------------------------------
  13. include-tagged::{doc-tests-file}[{api}-request]
  14. --------------------------------------------------
  15. <1> The ID of the job to stop.
  16. [id="{upid}-{api}-response"]
  17. ==== Response
  18. The returned +{response}+ indicates if the stop command was received.
  19. ["source","java",subs="attributes,callouts,macros"]
  20. --------------------------------------------------
  21. include-tagged::{doc-tests-file}[{api}-response]
  22. --------------------------------------------------
  23. <1> Whether or not the stop job request was received.
  24. include::../execution.asciidoc[]