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
editClusterUpdateSettingsResponse response = client.cluster().putSettings(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of a cluster update settings requires both the
ClusterUpdateSettingsRequest
instance and an ActionListener
instance to be
passed to the asynchronous 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.
A typical listener for ClusterUpdateSettingsResponse
looks like:
Cluster Update Settings Response
editThe returned ClusterUpdateSettings
allows to retrieve information about the
executed operation as follows: