github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-25 07:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add HLRC docs for Delete Lifecycle Policy (#35664)

Browse source 
Adds documenatation for the Delete Lifecycle Policy API to the HLRC
documentation.
This commit is contained in:
Gordon Brown 2018-11-20 11:32:41 -07:00 • committed by GitHub
parent 89cf4a7397
commit 17780ce07e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 112 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/java-rest/high-level/ilm/delete_lifecycle_policy.asciidoc Normal file
View file

@ -0,0 +1,36 @@
--
:api: ilm-delete-lifecycle-policy
:request: DeleteLifecyclePolicyRequest
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
=== Delete Lifecycle Policy API
[id="{upid}-{api}-request"]
==== Request
The Delete Lifecycle Policy API allows you to delete an Index Lifecycle
Management Policy from the cluster.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The policy named `my_policy` will be deleted.
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ indicates if the delete lifecycle policy request was received.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> Whether or not the delete lifecycle policy request was acknowledged.
include::../execution.asciidoc[]

2
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -457,6 +457,7 @@ The Java High Level REST Client supports the following Index Lifecycle
Management APIs:
* <<{upid}-ilm-put-lifecycle-policy>>
* <<{upid}-ilm-delete-lifecycle-policy>>
* <<{upid}-ilm-get-lifecycle-policy>>
* <<{upid}-ilm-start-ilm>>
* <<{upid}-ilm-stop-ilm>>
@ -465,6 +466,7 @@ Management APIs:
include::ilm/put_lifecycle_policy.asciidoc[]
include::ilm/delete_lifecycle_policy.asciidoc[]
include::ilm/get_lifecycle_policy.asciidoc[]
include::ilm/start_lifecycle_management.asciidoc[]
include::ilm/stop_lifecycle_management.asciidoc[]