Put Lifecycle Policy APIedit


The Put Lifecycle Policy API allows you to add an Index Lifecycle Management Policy to the cluster.

Map<String, Phase> phases = new HashMap<>();
Map<String, LifecycleAction> hotActions = new HashMap<>();
hotActions.put(RolloverAction.NAME, new RolloverAction(
        new ByteSizeValue(50, ByteSizeUnit.GB), null, null));
phases.put("hot", new Phase("hot", TimeValue.ZERO, hotActions)); 

Map<String, LifecycleAction> deleteActions =
        Collections.singletonMap(DeleteAction.NAME, new DeleteAction());
phases.put("delete", new Phase("delete",
        new TimeValue(90, TimeUnit.DAYS), deleteActions)); 

LifecyclePolicy policy = new LifecyclePolicy("my_policy",
PutLifecyclePolicyRequest request =
        new PutLifecyclePolicyRequest(policy);

Adds a hot phase with a rollover action

Adds a delete phase that will delete in the index 90 days after rollover

Creates the policy with the defined phases and the name my_policy


The returned AcknowledgedResponse indicates if the put lifecycle policy request was received.

boolean acknowledged = response.isAcknowledged(); 

Whether or not the put lifecycle policy was acknowledged.

Synchronous executionedit

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

AcknowledgedResponse response = client.indexLifecycle().
        putLifecyclePolicy(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 executionedit

Executing a PutLifecyclePolicyRequest 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-put-lifecycle-policy method:

        RequestOptions.DEFAULT, listener); 

The PutLifecyclePolicyRequest 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-put-lifecycle-policy looks like:

ActionListener<AcknowledgedResponse> listener =
        new ActionListener<AcknowledgedResponse>() {
    public void onResponse(AcknowledgedResponse response) {
        boolean acknowledged = response.isAcknowledged(); 

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole PutLifecyclePolicyRequest fails.