Remove Policy from Index API
editRemove Policy from Index API
editRequest
editRemoves the assigned lifecycle policy from an index.
Response
editThe returned AcknowledgedResponse indicates if the request to remove
the lifecycle policy from the index was received.
Synchronous execution
editWhen 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
editExecuting 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:
|
The |
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) {
}
};