OpenSearch/docs/java-rest/high-level/ml/delete-datafeed.asciidoc

--
:api: delete-datafeed 
:request: DeleteDatafeedRequest
:response: AcknowledgedResponse
--
[role="xpack"]
[id="{upid}-delete-datafeed"]
=== Delete datafeeds API

Deletes an existing datafeed.

[id="{upid}-{api}-request"]
==== Delete datafeeds request

A +{request}+ object requires a non-null `datafeedId` and can optionally set `force`.

["source","java",subs="attributes,callouts,macros"]
---------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
---------------------------------------------------
<1> Use to forcefully delete a started datafeed. This method is quicker than
stopping and deleting the datafeed. Defaults to `false`.

include::../execution.asciidoc[]

[id="{upid}-{api}-response"]
==== Delete datafeeds response

The returned +{response}+ object indicates the acknowledgement of the request:
["source","java",subs="attributes,callouts,macros"]
---------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
---------------------------------------------------
<1> `isAcknowledged` was the deletion request acknowledged or not.
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			`--`
			`:api: delete-datafeed`
			`:request: DeleteDatafeedRequest`
			`:response: AcknowledgedResponse`
			`--`
[DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 11:26:56 -04:00			`[role="xpack"]`
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			`[id="{upid}-delete-datafeed"]`
[DOCS] Fix titles for ML APIs (#63152) (#63207) 2020-10-02 17:01:01 -04:00			`=== Delete datafeeds API`
[DOCS] Updates terms in machine learning datafeed APIs (#44883) 2019-07-26 13:47:03 -04:00
			`Deletes an existing datafeed.`
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			`[id="{upid}-{api}-request"]`
[DOCS] Fix titles for ML APIs (#63152) (#63207) 2020-10-02 17:01:01 -04:00			`==== Delete datafeeds request`
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			A +{request}+ object requires a non-null `datafeedId` and can optionally set `force`.
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00
			`["source","java",subs="attributes,callouts,macros"]`
			`---------------------------------------------------`
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			`include-tagged::{doc-tests-file}[{api}-request]`
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00			`---------------------------------------------------`
[DOCS] Updates terms in machine learning datafeed APIs (#44883) 2019-07-26 13:47:03 -04:00			`<1> Use to forcefully delete a started datafeed. This method is quicker than`
			stopping and deleting the datafeed. Defaults to `false`.
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			`include::../execution.asciidoc[]`

			`[id="{upid}-{api}-response"]`
[DOCS] Fix titles for ML APIs (#63152) (#63207) 2020-10-02 17:01:01 -04:00			`==== Delete datafeeds response`
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			`The returned +{response}+ object indicates the acknowledgement of the request:`
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00			`["source","java",subs="attributes,callouts,macros"]`
			`---------------------------------------------------`
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs 2018-10-05 11:45:46 -04:00			`include-tagged::{doc-tests-file}[{api}-response]`
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827 2018-09-13 12:13:36 -04:00			`---------------------------------------------------`
[DOCS] Updates terms in machine learning datafeed APIs (#44883) 2019-07-26 13:47:03 -04:00			<1> `isAcknowledged` was the deletion request acknowledged or not.