The Put Snapshot Lifecycle Policy API allows you to add of update the definition of a Snapshot Lifecycle Management Policy in the cluster.
Map<String, Object> config = new HashMap<>(); config.put("indices", Collections.singletonList("idx")); SnapshotRetentionConfiguration retention = new SnapshotRetentionConfiguration(TimeValue.timeValueDays(30), 2, 10); SnapshotLifecyclePolicy policy = new SnapshotLifecyclePolicy( "policy_id", "name", "1 2 3 * * ?", "my_repository", config, retention); PutSnapshotLifecyclePolicyRequest request = new PutSnapshotLifecyclePolicyRequest(policy);
AcknowledgedResponse indicates if the put snapshot lifecycle policy request was received.
When executing a
PutSnapshotLifecyclePolicyRequest in the following manner, the client waits
AcknowledgedResponse to be returned before continuing with code execution:
AcknowledgedResponse resp = client.indexLifecycle() .putSnapshotLifecyclePolicy(request, RequestOptions.DEFAULT);
Synchronous calls may throw an
IOException in case of either failing to
parse the REST response in the high-level REST client, the request times out
or similar cases where there is no response coming back from the server.
In cases where the server returns a
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
PutSnapshotLifecyclePolicyRequest can also be done in an asynchronous fashion so that
the client can return directly. Users need to specify how the response or
potential failures will be handled by passing the request and a listener to the
asynchronous slm-put-snapshot-lifecycle-policy method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
if the execution successfully completed or using the
onFailure method if
it failed. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for
slm-put-snapshot-lifecycle-policy looks like: