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
editWhen executing a RefreshRequest
in the following manner, the client waits
for the RefreshResponse
to be returned before continuing with code execution:
RefreshResponse refreshResponse = client.indices().refresh(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 RefreshRequest
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 refresh 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 refresh
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: