Remove Policy from Index API

Request

Removes the assigned lifecycle policy from an index.

List<String> indices = new ArrayList<>();
indices.add("my_index");
RemoveIndexLifecyclePolicyRequest request =
    new RemoveIndexLifecyclePolicyRequest(indices); 

removes the my_policy policy from my_index

Response

The returned AcknowledgedResponse indicates if the request to remove the lifecycle policy from the index was received.

boolean hasFailures = response.hasFailures(); 
List<String> failedIndexes = response.getFailedIndexes(); 

Whether or not there were any policies failed to be removed from any indices from the request

A list of index names which are still managed by their policies.

Synchronous Execution

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

RemoveIndexLifecyclePolicyResponse response = client
    .indexLifecycle()
    .removeIndexLifecyclePolicy(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 RemoveIndexLifecyclePolicyRequest 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-remove-lifecycle-policy-from-index method:

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

The RemoveIndexLifecyclePolicyRequest 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-remove-lifecycle-policy-from-index looks like:

ActionListener<RemoveIndexLifecyclePolicyResponse> listener =
    new ActionListener<RemoveIndexLifecyclePolicyResponse>() {
        @Override
        public void onResponse(
                RemoveIndexLifecyclePolicyResponse response) {
            boolean hasFailures = response.hasFailures(); 
            List<String> failedIndexes = response.getFailedIndexes();
        }

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

Called when the execution is successfully completed.

Called when the whole RemoveIndexLifecyclePolicyRequest fails.