delete-data-frame-analytics.asciidoc 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  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. Delete an existing {dfanalytics-job}.
  10. The API accepts a +{request}+ object as a request and returns a +{response}+.
  11. [id="{upid}-{api}-request"]
  12. ==== Delete {dfanalytics-jobs} request
  13. A +{request}+ object requires a {dfanalytics-job} ID.
  14. ["source","java",subs="attributes,callouts,macros"]
  15. ---------------------------------------------------
  16. include-tagged::{doc-tests-file}[{api}-request]
  17. ---------------------------------------------------
  18. <1> Constructing a new request referencing an existing {dfanalytics-job}.
  19. ==== Optional arguments
  20. The following arguments are optional:
  21. ["source","java",subs="attributes,callouts,macros"]
  22. ---------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-request-force]
  24. ---------------------------------------------------
  25. <1> Use to forcefully delete a job that is not stopped. This method is quicker than stopping
  26. and deleting the job. Defaults to `false`.
  27. include::../execution.asciidoc[]
  28. [id="{upid}-{api}-response"]
  29. ==== Response
  30. The returned +{response}+ object acknowledges the {dfanalytics-job} deletion.