Update Indices Settings API
editUpdate Indices Settings API
editThe Update Indices Settings API allows to change specific index level settings.
Update Indices Settings Request
editAn UpdateSettingsRequest
:
Indices Settings
editAt least one setting to be updated must be provided:
Providing the Settings
editThe settings to be applied can be provided in different ways:
String settingKey = "index.number_of_replicas"; int settingValue = 0; Settings settings = Settings.builder() .put(settingKey, settingValue) .build();
Settings.Builder settingsBuilder = Settings.builder() .put(settingKey, settingValue); request.settings(settingsBuilder);
Optional Arguments
editThe following arguments can optionally be provided:
Whether to update existing settings. If set to |
Timeout to wait for the all the nodes to acknowledge the new setting
as a |
|
Timeout to wait for the all the nodes to acknowledge the new setting
as a |
Timeout to connect to the master node as a |
|
Timeout to connect to the master node as a |
Synchronous execution
editWhen executing a UpdateSettingsRequest
in the following manner, the client waits
for the UpdateSettingsResponse
to be returned before continuing with code execution:
AcknowledgedResponse updateSettingsResponse = client.indices().putSettings(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 UpdateSettingsRequest
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 indices-put-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 indices-put-settings
looks like:
Update Indices Settings Response
editThe returned UpdateSettingsResponse
allows to retrieve information about the
executed operation as follows: