2019-03-14 14:57:12 +00:00
|
|
|
--
|
2019-09-20 15:57:43 -07:00
|
|
|
:api: delete-transform
|
2019-09-25 07:38:17 +02:00
|
|
|
:request: DeleteTransformRequest
|
2019-03-14 14:57:12 +00:00
|
|
|
:response: AcknowledgedResponse
|
|
|
|
|
--
|
2019-09-11 11:21:45 -07:00
|
|
|
[role="xpack"]
|
2019-03-14 14:57:12 +00:00
|
|
|
[id="{upid}-{api}"]
|
2019-09-16 08:28:19 -07:00
|
|
|
=== Delete {transform} API
|
2019-07-25 10:08:38 -07:00
|
|
|
|
2019-09-16 08:28:19 -07:00
|
|
|
Deletes an existing {transform}.
|
2019-03-14 14:57:12 +00:00
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
2019-09-16 08:28:19 -07:00
|
|
|
==== Delete {transform} request
|
2019-03-14 14:57:12 +00:00
|
|
|
|
|
|
|
|
A +{request}+ object requires a non-null `id`.
|
|
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
---------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
|
|
---------------------------------------------------
|
2019-09-16 08:28:19 -07:00
|
|
|
<1> Constructing a new request referencing an existing {transform}
|
|
|
|
|
<2> Sets the optional argument `force`. When `true`, the {transform}
|
2019-07-22 13:13:25 -05:00
|
|
|
is deleted regardless of its current state. The default value is `false`,
|
2019-09-16 08:28:19 -07:00
|
|
|
meaning that only `stopped` {transforms} can be deleted.
|
2019-03-14 14:57:12 +00:00
|
|
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
|
|
==== Response
|
|
|
|
|
|
2019-09-16 08:28:19 -07:00
|
|
|
The returned +{response}+ object acknowledges the {transform} deletion.
|
