IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Close Index API

edit

Close Index API

edit

Close Index Request

edit

A CloseIndexRequest requires an index argument:

CloseIndexRequest request = new CloseIndexRequest("index");

The index to close

Optional arguments

edit

The following arguments can optionally be provided:

request.timeout(TimeValue.timeValueMinutes(2)); 
request.timeout("2m");

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

request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); 
request.masterNodeTimeout("1m");

	Timeout to connect to the master node as a `TimeValue`
	Timeout to connect to the master node as a `String`

request.indicesOptions(IndicesOptions.lenientExpandOpen());

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

Synchronous Execution

edit

CloseIndexResponse closeIndexResponse = client.indices().close(request);

Asynchronous Execution

edit

The asynchronous execution of a close index request requires both the CloseIndexRequest instance and an ActionListener instance to be passed to the asynchronous method:

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

A typical listener for CloseIndexResponse looks like:

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

    @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

Close Index Response

edit

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

« Open Index API Shrink Index API »