The Cluster Get Settings API allows to get the cluster wide settings.
ClusterGetSettingsRequest request = new ClusterGetSettingsRequest();
The 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.
When executing a
ClusterGetSettingsRequest in the following manner, the client waits
ClusterGetSettingsResponse to be returned before continuing with code execution:
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
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
ClusterGetSettingsRequest 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 get-settings method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
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
get-settings looks like:
ClusterGetSettingsResponse allows to retrieve information about the
executed operation as follows:
Get the persistent settings.
Get the transient settings.
Get the default settings (returns empty settings if
Get the value as a