WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Reload Search Analyzers API
editReload Search Analyzers API
editReload Search Analyzers Request
editAn ReloadAnalyzersRequest
requires an index
argument:
Optional arguments
editThe following arguments can optionally be provided:
Synchronous execution
editWhen 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 execution
editExecuting 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:
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:
Reload Search Analyzers Response
editThe 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 |