Close Index APIedit

Close Index Requestedit

A CloseIndexRequest requires an index argument:

CloseIndexRequest request = new CloseIndexRequest("index"); 

The index to close

Optional argumentsedit

The following arguments can optionally be provided:


Timeout to wait for the all the nodes to acknowledge the index is closed as a TimeValue


Timeout to connect to the master node as a TimeValue


Setting IndicesOptions controls how unavailable indices are resolved and how wildcard expressions are expanded

Synchronous executionedit

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

AcknowledgedResponse closeIndexResponse = client.indices().close(request, requestOptions);

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 executionedit

Executing a CloseIndexRequest 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 close-index method:

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

The CloseIndexRequest 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 close-index looks like:

ActionListener<CloseIndexResponse> listener = new ActionListener<CloseIndexResponse>() {
    public void onResponse(CloseIndexResponse closeIndexResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole CloseIndexRequest fails.

Close Index Responseedit

The returned CloseIndexResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = closeIndexResponse.isAcknowledged(); 

Indicates whether all of the nodes have acknowledged the request