delete_data_frame.asciidoc 942 B

12345678910111213141516171819202122232425262728293031
  1. --
  2. :api: delete-data-frame-transform
  3. :request: DeleteDataFrameTransformRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete {transform} API
  9. Deletes an existing {transform}.
  10. [id="{upid}-{api}-request"]
  11. ==== Delete {transform} request
  12. A +{request}+ object requires a non-null `id`.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. ---------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. ---------------------------------------------------
  17. <1> Constructing a new request referencing an existing {transform}
  18. <2> Sets the optional argument `force`. When `true`, the {transform}
  19. is deleted regardless of its current state. The default value is `false`,
  20. meaning that only `stopped` {transforms} can be deleted.
  21. include::../execution.asciidoc[]
  22. [id="{upid}-{api}-response"]
  23. ==== Response
  24. The returned +{response}+ object acknowledges the {transform} deletion.