Get Lifecycle Policy API

Request

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

GetLifecyclePolicyRequest allRequest =
    new GetLifecyclePolicyRequest(); 
GetLifecyclePolicyRequest request =
    new GetLifecyclePolicyRequest("my_policy", "other_policy"); 

Gets all policies.

Gets my_policy and other_policy

Response

The returned GetLifecyclePolicyResponse contains a map of LifecyclePolicyMetadata, accessible by the name of the policy, which contains data about each policy, as well as the policy definition.

ImmutableOpenMap<String, LifecyclePolicyMetadata> policies =
    response.getPolicies();
LifecyclePolicyMetadata myPolicyMetadata =
    policies.get("my_policy"); 
String myPolicyName = myPolicyMetadata.getName();
long version = myPolicyMetadata.getVersion();
String lastModified = myPolicyMetadata.getModifiedDateString();
long lastModifiedDate = myPolicyMetadata.getModifiedDate();
LifecyclePolicy myPolicy = myPolicyMetadata.getPolicy(); 

The retrieved policies are retrieved by name.

The policy definition itself.

Synchronous Execution

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

GetLifecyclePolicyResponse response = client.indexLifecycle()
    .getLifecyclePolicy(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 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 Execution

Executing a GetLifecyclePolicyRequest 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 ilm-get-lifecycle-policy method:

client.indexLifecycle().getLifecyclePolicyAsync(request,
    RequestOptions.DEFAULT, listener); 

The GetLifecyclePolicyRequest 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 ilm-get-lifecycle-policy looks like:

ActionListener<GetLifecyclePolicyResponse> listener =
    new ActionListener<GetLifecyclePolicyResponse>() {
        @Override
        public void onResponse(GetLifecyclePolicyResponse response)
        {
            ImmutableOpenMap<String, LifecyclePolicyMetadata>
                policies = response.getPolicies(); 
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

Called when the execution is successfully completed.

Called when the whole GetLifecyclePolicyRequest fails.