Clear Roles Cache APIedit

Clear Roles Cache Requestedit

A ClearRolesCacheRequest supports defining the name of roles that the cache should be cleared for.

ClearRolesCacheRequest request = new ClearRolesCacheRequest("my_role");

Synchronous executionedit

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

ClearRolesCacheResponse response =, 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 ClearRolesCacheRequest 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 clear-roles-cache method:, RequestOptions.DEFAULT, listener); 

The ClearRolesCacheRequest 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 clear-roles-cache looks like:

ClearRolesCacheRequest request = new ClearRolesCacheRequest("my_role");
ActionListener<ClearRolesCacheResponse> listener = new ActionListener<ClearRolesCacheResponse>() {
    public void onResponse(ClearRolesCacheResponse clearRolesCacheResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole ClearRolesCacheRequest fails.

Clear Roles Cache Responseedit

The returned ClearRolesCacheResponse allows to retrieve information about where the cache was cleared.

List<ClearRolesCacheResponse.Node> nodes = response.getNodes(); 

the list of nodes that the cache was cleared on