Refresh API

Refresh Request

A RefreshRequest can be applied to one or more indices, or even on _all the indices:

RefreshRequest request = new RefreshRequest("index1"); 
RefreshRequest requestMultiple = new RefreshRequest("index1", "index2"); 
RefreshRequest requestAll = new RefreshRequest(); 

Refresh one index

Refresh multiple indices

Refresh all the indices

Optional arguments

request.indicesOptions(IndicesOptions.lenientExpandOpen()); 

Setting IndicesOptions controls how unavailable indices are resolved and how wildcard expressions are expanded

Synchronous Execution

When 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

Executing 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:

client.indices().refreshAsync(request, RequestOptions.DEFAULT, listener); 

The RefreshRequest 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 refresh looks like:

ActionListener<RefreshResponse> listener = new ActionListener<RefreshResponse>() {
    @Override
    public void onResponse(RefreshResponse refreshResponse) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

Called when the execution is successfully completed.

Called when the whole RefreshRequest fails.

Refresh Response

The 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:

try {
    RefreshRequest request = new RefreshRequest("does_not_exist");
    client.indices().refresh(request, RequestOptions.DEFAULT);
} catch (ElasticsearchException exception) {
    if (exception.status() == RestStatus.NOT_FOUND) {
        
    }
}

Do something if the indices to be refreshed were not found