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.
« Cluster Update Settings API Cluster Health API »
Elastic Docs ›Java REST Client [6.4] ›Java High Level REST Client ›Cluster APIs

Cluster Get Settings API

edit

Cluster Get Settings API

edit

The Cluster Get Settings API allows to get the cluster wide settings.

Cluster Get Settings Request

edit

A ClusterGetSettingsRequest:

ClusterGetSettingsRequest request = new ClusterGetSettingsRequest();

Optional arguments

edit

The following arguments can optionally be provided:

request.includeDefaults(true);

By default only those settings that were explicitly set are returned. Setting this to true also returns the default settings.

 
request.local(true);

By default the request goes to the master of the cluster to get the latest results. If local is specified it gets the results from whichever node the request goes to.

 
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

Synchronous Execution

edit
ClusterGetSettingsResponse response = client.cluster().getSettings(request, RequestOptions.DEFAULT);

Execute the request and get back the response in a ClusterGetSettingsResponse object.

Asynchronous Execution

edit

The asynchronous execution of a cluster get settings requires both the ClusterGetSettingsRequest instance and an ActionListener instance to be passed to the asynchronous method:

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

The ClusterGetSettingsRequest 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 ClusterGetSettingsResponse looks like:

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

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

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

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

Cluster Get Settings Response

edit

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

Settings persistentSettings = response.getPersistentSettings(); 
Settings transientSettings = response.getTransientSettings(); 
Settings defaultSettings = response.getDefaultSettings(); 
String settingValue = response.getSetting("cluster.routing.allocation.enable");

Get the persistent settings.

Get the transient settings.

Get the default settings (returns empty settings if includeDefaults was not set to true).

Get the value as a String for a particular setting. The order of searching is first in persistentSettings then in transientSettings and finally, if not found in either, in defaultSettings.
« Cluster Update Settings API Cluster Health API »