Indices Exists API

Indices Exists Request

The high-level REST client uses a GetIndexRequest for Indices Exists API. The index name (or indices' names) are required.

GetIndexRequest request = new GetIndexRequest("twitter"); 

Index

Optional arguments

Indices Exists API also accepts following optional arguments, through a GetIndexRequest:

request.local(false); 
request.humanReadable(true); 
request.includeDefaults(false); 
request.indicesOptions(indicesOptions); 

Whether to return local information or retrieve the state from master node

Return result in a format suitable for humans

Whether to return all default setting for each of the indices

Controls how unavailable indices are resolved and how wildcard expressions are expanded

Synchronous Execution

When executing a GetIndexRequest in the following manner, the client waits for the boolean to be returned before continuing with code execution:

boolean exists = client.indices().exists(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

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 indices-exists method:

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

The GetIndexRequest to execute and the ActionListener to use when the execution completes

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 indices-exists looks like:

ActionListener<Boolean> listener = new ActionListener<Boolean>() {
    @Override
    public void onResponse(Boolean exists) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole GetIndexRequest fails.

Response

The response is a boolean value, indicating whether the index (or indices) exist.