IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Update Indices Settings API

edit

Update Indices Settings API

edit

The Update Indices Settings API allows to change specific index level settings.

Update Indices Settings Request

edit

An UpdateSettingsRequest:

UpdateSettingsRequest request = new UpdateSettingsRequest("index1"); 
UpdateSettingsRequest requestMultiple =
        new UpdateSettingsRequest("index1", "index2"); 
UpdateSettingsRequest requestAll = new UpdateSettingsRequest();

	Update settings for one index
	Update settings for multiple indices
	Update settings for all indices

Indices Settings

edit

At least one setting to be updated must be provided:

String settingKey = "index.number_of_replicas";
int settingValue = 0;
Settings settings =
        Settings.builder()
        .put(settingKey, settingValue)
        .build();

Sets the index settings to be applied

Providing the Settings

edit

The 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();

Creates a setting as Settings

Settings.Builder settingsBuilder =
        Settings.builder()
        .put(settingKey, settingValue);
request.settings(settingsBuilder);

Settings provided as Settings.Builder

request.settings(
        "{\"index.number_of_replicas\": \"2\"}"
        , XContentType.JSON);

Settings provided as String

Map<String, Object> map = new HashMap<>();
map.put(settingKey, settingValue);
request.settings(map);

Settings provided as a Map

Optional Arguments

edit

The following arguments can optionally be provided:

request.setPreserveExisting(false);

Whether to update existing settings. If set to true existing settings on an index remain unchanged, the default is false

request.timeout(TimeValue.timeValueMinutes(2)); 
request.timeout("2m");

	Timeout to wait for the all the nodes to acknowledge the new setting as a `TimeValue`
	Timeout to wait for the all the nodes to acknowledge the new setting as a `String`

request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); 
request.masterNodeTimeout("1m");

	Timeout to connect to the master node as a `TimeValue`
	Timeout to connect to the master node as a `String`

request.indicesOptions(IndicesOptions.lenientExpandOpen());

Setting IndicesOptions controls how unavailable indices are resolved and how wildcard expressions are expanded

Synchronous execution

edit

When 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

edit

Executing 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:

client.indices().putSettingsAsync(request, RequestOptions.DEFAULT, listener);

The UpdateSettingsRequest to execute and the ActionListener to use when the execution completes

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:

ActionListener<AcknowledgedResponse> listener =
        new ActionListener<AcknowledgedResponse>() {

    @Override
    public void onResponse(AcknowledgedResponse updateSettingsResponse) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

	Called when the execution is successfully completed.
	Called when the whole `UpdateSettingsRequest` fails.

Update Indices Settings Response

edit

The returned UpdateSettingsResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = updateSettingsResponse.isAcknowledged();

Indicates whether all of the nodes have acknowledged the request

« Get Alias API Get Settings API »