Get Settings APIedit
Get Settings Requestedit
A GetSettingsRequest
requires one or more index
arguments:
Optional argumentsedit
The following arguments can optionally be provided:
Synchronous Executionedit
GetSettingsResponse getSettingsResponse = client.indices().getSettings(request, RequestOptions.DEFAULT);
Asynchronous Executionedit
The asynchronous execution of a Get Settings request requires both the GetSettingsRequest
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 GetSettingsResponse
looks like:
Get Settings Responseedit
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.