44 lines
1.3 KiB
Plaintext
44 lines
1.3 KiB
Plaintext
--
|
|
:api: delete-data-frame-analytics
|
|
:request: DeleteDataFrameAnalyticsRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Delete {dfanalytics-jobs} API
|
|
|
|
experimental::[]
|
|
|
|
Delete an existing {dfanalytics-job}.
|
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Delete {dfanalytics-jobs} request
|
|
|
|
A +{request}+ object requires a {dfanalytics-job} ID.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
---------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
---------------------------------------------------
|
|
<1> Constructing a new request referencing an existing {dfanalytics-job}.
|
|
|
|
==== Optional arguments
|
|
|
|
The following arguments are optional:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
---------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request-options]
|
|
---------------------------------------------------
|
|
<1> Use to forcefully delete a job that is not stopped. This method is quicker than stopping
|
|
and deleting the job. Defaults to `false`.
|
|
<2> Use to set the time to wait until the job is deleted. Defaults to 1 minute.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ object acknowledges the {dfanalytics-job} deletion.
|