Close Index API
editClose Index API
editClose Index Request
editA CloseIndexRequest
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 closed
as a |
|
Timeout to wait for the all the nodes to acknowledge the index is closed
as a |
Timeout to connect to the master node as a |
|
Timeout to connect to the master node as a |
Synchronous Execution
editCloseIndexResponse closeIndexResponse = client.indices().close(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of a close index request requires both the CloseIndexRequest
instance and an ActionListener
instance to be passed to the asynchronous
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.
A typical listener for CloseIndexResponse
looks like:
Close Index Response
editThe returned CloseIndexResponse
allows to retrieve information about the
executed operation as follows: