delete_data_frame.asciidoc 996 B

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