Cluster Update Settings API
editCluster Update Settings API
editThe Cluster Update Settings API allows to update cluster wide settings.
Cluster Update Settings Request
editA ClusterUpdateSettingsRequest
:
ClusterUpdateSettingsRequest request = new ClusterUpdateSettingsRequest();
Cluster 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 transientSettingKey = RecoverySettings.INDICES_RECOVERY_MAX_BYTES_PER_SEC_SETTING.getKey(); int transientSettingValue = 10; Settings transientSettings = Settings.builder() .put(transientSettingKey, transientSettingValue, ByteSizeUnit.BYTES) .build(); String persistentSettingKey = EnableAllocationDecider.CLUSTER_ROUTING_ALLOCATION_ENABLE_SETTING.getKey(); String persistentSettingValue = EnableAllocationDecider.Allocation.NONE.name(); Settings persistentSettings = Settings.builder() .put(persistentSettingKey, persistentSettingValue) .build();
Settings.Builder transientSettingsBuilder = Settings.builder() .put(transientSettingKey, transientSettingValue, ByteSizeUnit.BYTES); request.transientSettings(transientSettingsBuilder);
request.transientSettings( "{\"indices.recovery.max_bytes_per_sec\": \"10b\"}" , XContentType.JSON);
Optional Arguments
editThe following arguments can optionally be provided:
Timeout to wait for the all the nodes to acknowledge the settings were applied
as a |
|
Timeout to wait for the all the nodes to acknowledge the settings were applied
as a |
Synchronous Execution
editWhen executing a ClusterUpdateSettingsRequest
in the following manner, the client waits
for the ClusterUpdateSettingsResponse
to be returned before continuing with code execution:
ClusterUpdateSettingsResponse response = client.cluster().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 ClusterUpdateSettingsRequest
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 put-settings method:
The |
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 put-settings
looks like:
Cluster Update Settings Response
editThe returned ClusterUpdateSettingsResponse
allows to retrieve information about the
executed operation as follows: