Get Index API
editGet Index API
editGet Index Request
editA GetIndexRequest
requires one or more index
arguments:
Optional arguments
editThe following arguments can optionally be provided:
Synchronous Execution
editGetIndexResponse getIndexResponse = client.indices().get(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of a Get Index request requires both the GetIndexRequest
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 GetIndexResponse
looks like:
Get Index Response
editThe returned GetIndexResponse
allows to retrieve information about the
executed operation as follows:
ImmutableOpenMap<String, MappingMetaData> indexMappings = getIndexResponse.getMappings().get("index"); Map<String, Object> indexTypeMappings = indexMappings.get("doc").getSourceAsMap(); List<AliasMetaData> indexAliases = getIndexResponse.getAliases().get("index"); String numberOfShardsString = getIndexResponse.getSetting("index", "index.number_of_shards"); Settings indexSettings = getIndexResponse.getSettings().get("index"); Integer numberOfShards = indexSettings.getAsInt("index.number_of_shards", null); TimeValue time = getIndexResponse.defaultSettings().get("index") .getAsTime("index.refresh_interval", null);
Retrieve a Map of different types to |
|
Retrieve a Map for the properties for document type |
|
Get the list of aliases for |
|
Get the value for the setting string |
|
Retrieve all settings for |
|
The |
|
Get the default setting |