Open Index API
editOpen Index API
editOpen Index Request
editAn OpenIndexRequest
requires an index
argument:
Optional arguments
editThe following arguments can optionally be provided:
Timeout to wait for the all the nodes to acknowledge the index is opened
as a |
|
Timeout to wait for the all the nodes to acknowledge the index is opened
as a |
Timeout to connect to the master node as a |
|
Timeout to connect to the master node as a |
The number of active shard copies to wait for before the open index API
returns a response, as an |
|
The number of active shard copies to wait for before the open index API
returns a response, as an |
Synchronous execution
editWhen executing a OpenIndexRequest
in the following manner, the client waits
for the OpenIndexResponse
to be returned before continuing with code execution:
OpenIndexResponse openIndexResponse = client.indices().open(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
editExecuting a OpenIndexRequest
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 open-index method:
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 open-index
looks like:
Open Index Response
editThe returned OpenIndexResponse
allows to retrieve information about the
executed operation as follows: