WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
FreezeIndexRequest requires an
The following arguments can optionally be provided:
The number of active shard copies to wait for before the freeze index API
returns a response, as an
When executing a
FreezeIndexRequest in the following manner, the client waits
FreezeIndexResponse to be returned before continuing with code execution:
ShardsAcknowledgedResponse openIndexResponse = client.indices().freeze(request, freezeIndexOptions);
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
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
FreezeIndexRequest 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 freeze-index method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
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
freeze-index looks like:
FreezeIndexResponse allows to retrieve information about the
executed operation as follows: