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/retry_lifecycle_policy.asci...

37 lines
1022 B
Plaintext
Raw Normal View History

[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
--
:api: ilm-retry-lifecycle-policy
:request: RetryLifecyclePolicyRequest
:response: AcknowledgedResponse
--
[DOCS] Adds missing icons to ILM HLRC APIs (#46633)
2019-09-11 18:45:07 -04:00
[role="xpack"]
[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
[id="{upid}-{api}"]
=== Retry Lifecycle Policy API
[id="{upid}-{api}-request"]
==== Request
The Retry Lifecycle Policy API allows you to invoke execution of policies
that encountered errors in certain indices.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> Retries execution of `my_index`'s policy
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ indicates if the retry lifecycle policy request was received.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> Whether or not the lifecycle policy retry was acknowledged.
include::../execution.asciidoc[]