Refresh API
editRefresh API
editRefresh Request
editA RefreshRequest
can be applied to one or more indices, or even on _all
the indices:
Optional arguments
editSynchronous Execution
editRefreshResponse refreshResponse = client.indices().refresh(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of a refresh request requires both the RefreshRequest
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 RefreshResponse
looks like:
Refresh Response
editThe returned RefreshResponse
allows to retrieve information about the
executed operation as follows:
int totalShards = refreshResponse.getTotalShards(); int successfulShards = refreshResponse.getSuccessfulShards(); int failedShards = refreshResponse.getFailedShards(); DefaultShardOperationFailedException[] failures = refreshResponse.getShardFailures();
Total number of shards hit by the refresh request |
|
Number of shards where the refresh has succeeded |
|
Number of shards where the refresh 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: