Execute Snapshot Lifecycle Retention APIedit


The Execute Snapshot Lifecycle Retention API allows you to execute Snapshot Lifecycle Management Retention immediately, rather than waiting for its regularly scheduled execution.

ExecuteSnapshotLifecycleRetentionRequest req =
    new ExecuteSnapshotLifecycleRetentionRequest();


The returned AcknowledgedResponse contains a boolean for whether the request was acknowledged by the master node.

final boolean acked = retentionResp.isAcknowledged();

Synchronous executionedit

When executing a ExecuteSnapshotLifecycleRetentionRequest in the following manner, the client waits for the AcknowledgedResponse to be returned before continuing with code execution:

AcknowledgedResponse retentionResp =

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 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous executionedit

Executing a ExecuteSnapshotLifecycleRetentionRequest 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-execute-snapshot-lifecycle-retention method:

        RequestOptions.DEFAULT, retentionListener); 

The ExecuteSnapshotLifecycleRetentionRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method 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-execute-snapshot-lifecycle-retention looks like:

ActionListener<AcknowledgedResponse> retentionListener =
    new ActionListener<AcknowledgedResponse>() {
        public void onResponse(AcknowledgedResponse r) {
            assert r.isAcknowledged(); 

        public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole ExecuteSnapshotLifecycleRetentionRequest fails.