Stop Index Lifecycle Management API

Request

The Stop Lifecycle Management API allows you to stop Index Lifecycle Management temporarily.

StopILMRequest request = new StopILMRequest();

Response

The returned AcknowledgedResponse indicates if the request to stop Index Lifecycle Management was received.

boolean acknowledged = response.isAcknowledged(); 

Whether or not the request to stop Index Lifecycle Management was acknowledged.

Synchronous Execution

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

AcknowledgedResponse response = client.indexLifecycle()
    .stopILM(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 StopILMRequest 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-stop-ilm method:

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

The StopILMRequest 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-stop-ilm looks like:

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

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

Called when the execution is successfully completed.

Called when the whole StopILMRequest fails.