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
editWhen executing a GetIndexRequest
in the following manner, the client waits
for the GetIndexResponse
to be returned before continuing with code execution:
GetIndexResponse getIndexResponse = client.indices().get(request, RequestOptions.DEFAULT);
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 4xx
or 5xx
error code, the high-level
client tries to parse the response body error details instead and then throws
a generic ElasticsearchException
and adds the original ResponseException
as a
suppressed exception to it.
Asynchronous Execution
editExecuting a GetIndexRequest
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-index 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. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for get-index
looks like:
Get Index Response
editThe returned GetIndexResponse
allows to retrieve information about the
executed operation as follows:
MappingMetaData indexMappings = getIndexResponse.getMappings().get("index"); Map<String, Object> indexTypeMappings = indexMappings.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.getDefaultSettings().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 |