Index Lifecycle Management Status API

Request

The Index Lifecycle Management Status API allows you to retrieve the status of Index Lifecycle Management

LifecycleManagementStatusRequest request =
    new LifecycleManagementStatusRequest();

Response

The returned AcknowledgedResponse indicates the status of Index Lifecycle Management.

OperationMode operationMode = response.getOperationMode(); 

The returned status can be RUNNING, STOPPING, or STOPPED.

Synchronous Execution

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

LifecycleManagementStatusResponse response =
    client.indexLifecycle()
        .lifecycleManagementStatus(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 LifecycleManagementStatusRequest 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-status method:

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

The LifecycleManagementStatusRequest 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-status looks like:

ActionListener<LifecycleManagementStatusResponse> listener =
    new ActionListener<LifecycleManagementStatusResponse>() {
        @Override
        public void onResponse(
                LifecycleManagementStatusResponse response) {
            OperationMode operationMode = response
                .getOperationMode(); 
        }

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

Called when the execution is successfully completed.

Called when the whole LifecycleManagementStatusRequest fails.