Cluster Get Settings API
editCluster Get Settings API
editThe Cluster Get Settings API allows to get the cluster wide settings.
Cluster Get Settings Request
editA ClusterGetSettingsRequest
:
ClusterGetSettingsRequest request = new ClusterGetSettingsRequest();
Optional arguments
editThe following arguments can optionally be provided:
By default only those settings that were explicitly set are returned. Setting this to true also returns the default settings. |
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. |
Synchronous Execution
editAsynchronous Execution
editThe asynchronous execution of a cluster get settings requires both the
ClusterGetSettingsRequest
instance and an ActionListener
instance to be
passed to the asynchronous method:
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:
Cluster Get Settings Response
editThe 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 |
|
Get the value as a |