Reload Search Analyzers APIedit

Reload Search Analyzers Requestedit

An ReloadAnalyzersRequest requires an index argument:

ReloadAnalyzersRequest request = new ReloadAnalyzersRequest("index"); 

The index to reload

Optional argumentsedit

The following arguments can optionally be provided:


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

Synchronous executionedit

When executing a ReloadAnalyzersRequest in the following manner, the client waits for the ReloadAnalyzersResponse to be returned before continuing with code execution:

ReloadAnalyzersResponse reloadResponse = client.indices().reloadAnalyzers(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 executionedit

Executing a ReloadAnalyzersRequest 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 reload-analyzers method:

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

The ReloadAnalyzersRequest 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 reload-analyzers looks like:

ActionListener<ReloadAnalyzersResponse> listener =
    new ActionListener<ReloadAnalyzersResponse>() {
        public void onResponse(ReloadAnalyzersResponse reloadResponse) {

        public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole ReloadAnalyzersRequest fails.

Reload Search Analyzers Responseedit

The returned ReloadAnalyzersResponse allows to retrieve information about the executed operation as follows:

Shards shards = reloadResponse.shards(); 
Map<String, ReloadDetails> reloadDetails = reloadResponse.getReloadedDetails(); 
ReloadDetails details = reloadDetails.get("index"); 
String indexName = details.getIndexName(); 
Set<String> indicesNodes = details.getReloadedIndicesNodes(); 
Set<String> analyzers = details.getReloadedAnalyzers();  

Shard statistics. Note that reloading does not happen on each shard of an index, but once on each node the index has shards on. The reported shard count can therefore differ from the number of index shards

Reloading details of all indices the request was executed on

Details can be retrieved by index name

The reloaded index name

The nodes the index was reloaded on

The analyzer names that were reloaded