Get Snapshot Lifecycle Policy APIedit


The Get Snapshot Lifecycle Policy API allows you to retrieve the definition of a Snapshot Lifecycle Management Policy from the cluster.

GetSnapshotLifecyclePolicyRequest getAllRequest =
    new GetSnapshotLifecyclePolicyRequest(); 
GetSnapshotLifecyclePolicyRequest getRequest =
    new GetSnapshotLifecyclePolicyRequest("policy_id"); 

Gets all policies.

Gets policy_id


The returned GetSnapshotLifecyclePolicyResponse contains a map of SnapshotLifecyclePolicyMetadata, accessible by the id of the policy, which contains data about each policy, as well as the policy definition.

SnapshotLifecyclePolicyMetadata policyMeta =
long policyVersion = policyMeta.getVersion();
long policyModificationDate = policyMeta.getModifiedDate();
long nextPolicyExecutionDate = policyMeta.getNextExecution();
SnapshotInvocationRecord lastSuccess = policyMeta.getLastSuccess();
SnapshotInvocationRecord lastFailure = policyMeta.getLastFailure();
SnapshotLifecyclePolicyMetadata.SnapshotInProgress inProgress =
SnapshotLifecyclePolicy retrievedPolicy = policyMeta.getPolicy(); 
String id = retrievedPolicy.getId();
String snapshotNameFormat = retrievedPolicy.getName();
String repositoryName = retrievedPolicy.getRepository();
String schedule = retrievedPolicy.getSchedule();
Map<String, Object> snapshotConfiguration = retrievedPolicy.getConfig();

The retrieved policies are retrieved by id.

The policy definition itself.

Synchronous executionedit

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

GetSnapshotLifecyclePolicyResponse getResponse =

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 GetSnapshotLifecyclePolicyRequest 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-get-snapshot-lifecycle-policy method:

    RequestOptions.DEFAULT, getListener); 

The GetSnapshotLifecyclePolicyRequest 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-get-snapshot-lifecycle-policy looks like:

ActionListener<GetSnapshotLifecyclePolicyResponse> getListener =
        new ActionListener<GetSnapshotLifecyclePolicyResponse>() {
    public void onResponse(GetSnapshotLifecyclePolicyResponse resp) {
        Map<String, SnapshotLifecyclePolicyMetadata> policies =

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole GetSnapshotLifecyclePolicyRequest fails.