Clear API Key Cache API
editClear API Key Cache API
editClear API Key Cache Request
editA ClearApiKeyCacheRequest
supports clearing API key cache for the given IDs.
It can also clear the entire cache if no ID is specified.
Synchronous execution
editWhen executing a ClearApiKeyCacheRequest
in the following manner, the client waits
for the ClearSecurityCacheResponse
to be returned before continuing with code execution:
ClearSecurityCacheResponse response = client.security().clearApiKeyCache(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 ClearApiKeyCacheRequest
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-api-key-cache method:
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-api-key-cache
looks like:
ClearApiKeyCacheRequest request = ClearApiKeyCacheRequest.clearById("yVGMr3QByxdh1MSaicYx"); ActionListener<ClearSecurityCacheResponse> listener = new ActionListener<ClearSecurityCacheResponse>() { @Override public void onResponse(ClearSecurityCacheResponse clearSecurityCacheResponse) { } @Override public void onFailure(Exception e) { } };
Clear API Key Cache Response
editThe returned ClearSecurityCacheResponse
allows to retrieve information about where the cache was cleared.