|
@@ -4,10 +4,12 @@
|
|
|
:response: AcknowledgedResponse
|
|
|
--
|
|
|
[id="{upid}-{api}"]
|
|
|
-=== Delete Job API
|
|
|
+=== Delete {anomaly-job} API
|
|
|
+
|
|
|
+Deletes an {anomaly-job} that exists in the cluster.
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
|
-==== Delete Job Request
|
|
|
+==== Delete {anomaly-job} request
|
|
|
|
|
|
A +{request}+ object requires a non-null `jobId` and can optionally set `force`.
|
|
|
|
|
@@ -17,7 +19,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
|
|
---------------------------------------------------
|
|
|
<1> Constructing a new request referencing an existing `jobId`
|
|
|
|
|
|
-==== Optional Arguments
|
|
|
+==== Optional arguments
|
|
|
|
|
|
The following arguments are optional:
|
|
|
|
|
@@ -33,21 +35,24 @@ Defaults to `false`.
|
|
|
---------------------------------------------------
|
|
|
include-tagged::{doc-tests-file}[{api}-request-wait-for-completion]
|
|
|
---------------------------------------------------
|
|
|
-<1> Use to set whether the request should wait until the operation has completed before returning.
|
|
|
-Defaults to `true`.
|
|
|
+<1> Use to set whether the request should wait until the operation has completed
|
|
|
+before returning. Defaults to `true`.
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
-==== Delete Job Response
|
|
|
+==== Delete {anomaly-job} response
|
|
|
|
|
|
-The returned +{response}+ object indicates the acknowledgement of the job deletion or
|
|
|
-the deletion task depending on whether the request was set to wait for completion:
|
|
|
+The returned +{response}+ object indicates the acknowledgement of the job
|
|
|
+deletion or the deletion task depending on whether the request was set to wait
|
|
|
+for completion:
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
|
---------------------------------------------------
|
|
|
-<1> whether was job deletion was acknowledged or not; will be `null` when set not to wait for completion
|
|
|
-<2> the id of the job deletion task; will be `null` when set to wait for completion
|
|
|
+<1> whether was job deletion was acknowledged or not; will be `null` when set
|
|
|
+not to wait for completion
|
|
|
+<2> the id of the job deletion task; will be `null` when set to wait for
|
|
|
+completion
|
|
|
|
|
|
include::../execution.asciidoc[]
|