Indices Exists APIedit

Indices Exists Requestedit

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

GetIndexRequest request = new GetIndexRequest();
request.indices("twitter"); 

Index

Optional argumentsedit

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 Executionedit

boolean exists = client.indices().exists(request);

Asynchronous Executionedit

The asynchronous execution of an indices exists request requires both the GetIndexRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.indices().existsAsync(request, 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.

A typical listener for the 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. The response is provided as an argument

Called in case of failure. The raised exception is provided as an argument

Responseedit

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

boolean exists = client.indices().exists(request);