Get Index API

A GetIndexRequest requires one or more index arguments:

GetIndexRequest request = new GetIndexRequest("index"); 

The following arguments can optionally be provided:

request.includeDefaults(true); 

request.indicesOptions(IndicesOptions.lenientExpandOpen()); 

When 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.

Executing 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:

client.indices().getAsync(request, RequestOptions.DEFAULT, listener); 

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:

ActionListener<GetIndexResponse> listener =
    new ActionListener<GetIndexResponse>() {
        @Override
        public void onResponse(GetIndexResponse getIndexResponse) {
            
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

The 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);