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-calendar.asciidoc

34 lines
1.0 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-calendar
:request: DeleteCalendarRequest
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
HLRC: Delete ML calendar (#33775)
2018-09-19 05:20:21 -04:00
=== Delete Calendar API
Delete a {ml} calendar.
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 API accepts a +{request}+ and responds
with a +{response}+ object.
HLRC: Delete ML calendar (#33775)
2018-09-19 05:20:21 -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"]
HLRC: Delete ML calendar (#33775)
2018-09-19 05:20:21 -04:00
==== Delete Calendar Request
A `DeleteCalendar` object requires a non-null `calendarId`.
["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: Delete ML calendar (#33775)
2018-09-19 05:20:21 -04:00
---------------------------------------------------
<1> Constructing a new request referencing an existing Calendar
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}-response"]
HLRC: Delete ML calendar (#33775)
2018-09-19 05:20:21 -04:00
==== Delete Calendar 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: Delete ML calendar (#33775)
2018-09-19 05:20:21 -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: Delete ML calendar (#33775)
2018-09-19 05:20:21 -04:00
---------------------------------------------------
<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
include::../execution.asciidoc[]