Get Settings API
editGet Settings API
editGet Settings Request
editA GetSettingsRequest
requires one or more index
arguments:
Optional arguments
editThe following arguments can optionally be provided:
Synchronous execution
editWhen executing a GetSettingsRequest
in the following manner, the client waits
for the GetSettingsResponse
to be returned before continuing with code execution:
GetSettingsResponse getSettingsResponse = client.indices().getSettings(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 GetSettingsRequest
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 get-settings 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 get-settings
looks like:
Get Settings Response
editThe returned GetSettingsResponse
allows to retrieve information about the
executed operation as follows:
String numberOfShardsString = getSettingsResponse.getSetting("index", "index.number_of_shards"); Settings indexSettings = getSettingsResponse.getIndexToSettings().get("index"); Integer numberOfShards = indexSettings.getAsInt("index.number_of_shards", null);
We can retrieve the setting value for a particular index directly from the response as a string |
|
We can also retrieve the Settings object for a particular index for further examination |
|
The returned Settings object provides convenience methods for non String types |
If the includeDefaults
flag was set to true in the GetSettingsRequest
the
behavior of GetSettingsResponse
will differ somewhat.