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

› › ›

Open Index API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Open Index API

edit

Open Index Request

edit

An OpenIndexRequest requires an index argument:

OpenIndexRequest request = new OpenIndexRequest("index");

The index to open

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 opened as a `TimeValue`
	Timeout to wait for the all the nodes to acknowledge the index is opened 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.waitForActiveShards(2); 
request.waitForActiveShards(ActiveShardCount.ONE);

	The number of active shard copies to wait for before the open index API returns a response, as an `int`
	The number of active shard copies to wait for before the open index API returns a response, as an `ActiveShardCount`

request.indicesOptions(IndicesOptions.strictExpandOpen());

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

Synchronous Execution

edit

OpenIndexResponse openIndexResponse = client.indices().open(request);

Asynchronous Execution

edit

The asynchronous execution of an open index request requires both the OpenIndexRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.indices().openAsync(request, listener);

The OpenIndexRequest 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 OpenIndexResponse looks like:

ActionListener<OpenIndexResponse> listener =
        new ActionListener<OpenIndexResponse>() {
    @Override
    public void onResponse(OpenIndexResponse openIndexResponse) {
        
    }

    @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

Open Index Response

edit

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

boolean acknowledged = openIndexResponse.isAcknowledged(); 
boolean shardsAcked = openIndexResponse.isShardsAcknowledged();

	Indicates whether all of the nodes have acknowledged the request
	Indicates whether the requisite number of shard copies were started for each shard in the index before timing out

« Indices Exists API Close Index API »