delete-data-frame-analytics.asciidoc 953 B

1234567891011121314151617181920212223242526272829
  1. --
  2. :api: delete-data-frame-analytics
  3. :request: DeleteDataFrameAnalyticsRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete Data Frame Analytics API
  9. The Delete Data Frame Analytics API is used to delete an existing {dataframe-analytics-config}.
  10. The API accepts a +{request}+ object as a request and returns a +{response}+.
  11. [id="{upid}-{api}-request"]
  12. ==== Delete Data Frame Analytics Request
  13. A +{request}+ object requires a {dataframe-analytics-config} 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 {dataframe-analytics-config}
  19. include::../execution.asciidoc[]
  20. [id="{upid}-{api}-response"]
  21. ==== Response
  22. The returned +{response}+ object acknowledges the {dataframe-analytics-config} deletion.