honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/ml/delete-datafeed.asciidoc

33 lines
1.1 KiB
Plaintext
Raw Normal View History

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
--
[id="{upid}-delete-datafeed"]
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827
2018-09-13 12:13:36 -04:00
=== Delete Datafeed API
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"]
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827
2018-09-13 12:13:36 -04:00
==== Delete Datafeed Request
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
---------------------------------------------------
<1> Use to forcefully delete a started datafeed;
this method is quicker than stopping and deleting the datafeed.
Defaults to `false`.
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"]
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827
2018-09-13 12:13:36 -04:00
==== Delete Datafeed Response
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
---------------------------------------------------
<1> `isAcknowledged` was the deletion request acknowledged or not