New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
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 Put Template API »
Elastic Docs ›Java REST Client [6.4] ›Java High Level REST Client ›Indices APIs

Get Settings API

edit

Get Settings API

edit

Get Settings Request

edit

A GetSettingsRequest requires one or more index arguments:

GetSettingsRequest request = new GetSettingsRequest().indices("index");

The index whose settings we should retrieve

Optional arguments

edit

The following arguments can optionally be provided:

request.names("index.number_of_shards");

One or more settings that be the only settings retrieved. If unset, all settings will be retrieved

 
request.includeDefaults(true);

If true, defaults will be returned for settings not explicitly set on the index

 
request.indicesOptions(IndicesOptions.lenientExpandOpen());

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

Synchronous Execution

edit
GetSettingsResponse getSettingsResponse = client.indices().getSettings(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of a Get Settings request requires both the GetSettingsRequest instance and an ActionListener instance to be passed to the asynchronous method:

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

The GetSettingsRequest 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.

A typical listener for GetSettingsResponse looks like:

ActionListener<GetSettingsResponse> listener =
    new ActionListener<GetSettingsResponse>() {
        @Override
        public void onResponse(GetSettingsResponse GetSettingsResponse) {
            
        }

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

Called when the execution is successfully completed. The response is provided as an argument

Called in case of failure. The raised exception is provided as an argument

Get Settings Response

edit

The 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.

String refreshInterval = getSettingsResponse.getSetting("index", "index.refresh_interval"); 
Settings indexDefaultSettings = getSettingsResponse.getIndexToDefaultSettings().get("index");

Individual default setting values may be retrieved directly from the GetSettingsResponse

We may retrieve a Settings object for an index that contains those settings with default values
« Update Indices Settings API Put Template API »