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/ilm/put_lifecycle_policy.asciidoc

39 lines
1.1 KiB
Plaintext
Raw Normal View History

Adds HLRC docs for put lifecycle policy (#35457) * Adds HLRC docs for put lifecycle policy * Adds link to docs in client javadocs * Fixes checkstyle * Make the documentation use the right ack response
2018-11-13 15:40:53 -05:00
--
:api: ilm-put-lifecycle-policy
:request: PutLifecyclePolicyRequest
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
=== Put Lifecycle Policy API
[id="{upid}-{api}-request"]
==== Request
The Put Lifecycle Policy API allows you to add an Index Lifecycle Management
Policy to the cluster.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> Adds a hot phase with a rollover action
<2> Adds a delete phase that will delete in the index 90 days after rollover
<3> Creates the policy with the defined phases and the name `my_policy`
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ indicates if the put lifecycle policy request was received.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
[ILM] HLRC-ILM Retry Lifecycle Policy docs (#35715) this adds documentation for the retry method in the high-level-ilm-rest-client. this PR also renames retryLifecycleStep to retryLifecyclePolicy in the index-lifecycle-client
2018-11-20 10:05:27 -05:00
<1> Whether or not the put lifecycle policy was acknowledged.
Adds HLRC docs for put lifecycle policy (#35457) * Adds HLRC docs for put lifecycle policy * Adds link to docs in client javadocs * Fixes checkstyle * Make the documentation use the right ack response
2018-11-13 15:40:53 -05:00
include::../execution.asciidoc[]