delete_data_frame.asciidoc 952 B

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