Clear Cache API
editClear Cache API
editClear Cache Request
editA ClearIndicesCacheRquest
can be applied to one or more indices, or even on
_all
the indices:
Optional arguments
edit
Setting |
Synchronous Execution
editClearIndicesCacheResponse clearCacheResponse = client.indices().clearCache(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of a clear cache request requires both the ClearIndicesCacheRequest
instance and an ActionListener
instance to be passed to the asynchronous
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.
A typical listener for ClearIndicesCacheResponse
looks like:
Clear Cache Response
editThe returned ClearIndicesCacheResponse
allows to retrieve information about the
executed operation as follows:
int totalShards = clearCacheResponse.getTotalShards(); int successfulShards = clearCacheResponse.getSuccessfulShards(); int failedShards = clearCacheResponse.getFailedShards(); DefaultShardOperationFailedException[] failures = clearCacheResponse.getShardFailures();
Total number of shards hit by the clear cache request |
|
Number of shards where the clear cache has succeeded |
|
Number of shards where the clear cache has failed |
|
A list of failures if the operation failed on one or more shards |
By default, if the indices were not found, an ElasticsearchException
will be thrown: