2019-03-14 10:57:12 -04:00
|
|
|
--
|
|
|
|
|
:api: delete-data-frame-transform
|
|
|
|
|
:request: DeleteDataFrameTransformRequest
|
|
|
|
|
:response: AcknowledgedResponse
|
|
|
|
|
--
|
|
|
|
|
[id="{upid}-{api}"]
|
2019-07-25 13:08:38 -04:00
|
|
|
=== Delete {dataframe-transform} API
|
|
|
|
|
|
|
|
|
|
Deletes an existing {dataframe-transform}.
|
2019-03-14 10:57:12 -04:00
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
2019-07-25 13:08:38 -04:00
|
|
|
==== Delete {dataframe-transform} request
|
2019-03-14 10:57:12 -04:00
|
|
|
|
|
|
|
|
A +{request}+ object requires a non-null `id`.
|
|
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
---------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
|
|
---------------------------------------------------
|
|
|
|
|
<1> Constructing a new request referencing an existing {dataframe-transform}
|
2019-07-22 14:13:25 -04:00
|
|
|
<2> Sets the optional argument `force`. When `true`, the {dataframe-transform}
|
|
|
|
|
is deleted regardless of its current state. The default value is `false`,
|
|
|
|
|
meaning that only `stopped` {dataframe-transforms} can be deleted.
|
2019-03-14 10:57:12 -04:00
|
|
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
|
|
==== Response
|
|
|
|
|
|
|
|
|
|
The returned +{response}+ object acknowledges the Data Frame Transform deletion.
|
