delete-data-frame-analytics.asciidoc 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. --
  2. :api: delete-data-frame-analytics
  3. :request: DeleteDataFrameAnalyticsRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete {dfanalytics-jobs} API
  9. beta::[]
  10. Delete an existing {dfanalytics-job}.
  11. The API accepts a +{request}+ object as a request and returns a +{response}+.
  12. [id="{upid}-{api}-request"]
  13. ==== Delete {dfanalytics-jobs} request
  14. A +{request}+ object requires a {dfanalytics-job} ID.
  15. ["source","java",subs="attributes,callouts,macros"]
  16. ---------------------------------------------------
  17. include-tagged::{doc-tests-file}[{api}-request]
  18. ---------------------------------------------------
  19. <1> Constructing a new request referencing an existing {dfanalytics-job}.
  20. ==== Optional arguments
  21. The following arguments are optional:
  22. ["source","java",subs="attributes,callouts,macros"]
  23. ---------------------------------------------------
  24. include-tagged::{doc-tests-file}[{api}-request-options]
  25. ---------------------------------------------------
  26. <1> Use to forcefully delete a job that is not stopped. This method is quicker than stopping
  27. and deleting the job. Defaults to `false`.
  28. <2> Use to set the time to wait until the job is deleted. Defaults to 1 minute.
  29. include::../execution.asciidoc[]
  30. [id="{upid}-{api}-response"]
  31. ==== Response
  32. The returned +{response}+ object acknowledges the {dfanalytics-job} deletion.