Freeze Index API

edit

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

Freeze Index API

edit

Freeze Index Request

edit

An FreezeIndexRequest requires an index argument:

FreezeIndexRequest request = new FreezeIndexRequest("index");

The index to freeze

Optional arguments

edit

The following arguments can optionally be provided:

request.setTimeout(TimeValue.timeValueMinutes(2));

Timeout to wait for the all the nodes to acknowledge the index is frozen as a TimeValue

request.setMasterTimeout(TimeValue.timeValueMinutes(1));

Timeout to connect to the master node as a TimeValue

request.setWaitForActiveShards(ActiveShardCount.DEFAULT);

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

request.setIndicesOptions(IndicesOptions.strictExpandOpen());

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

Synchronous execution

edit

When executing a FreezeIndexRequest in the following manner, the client waits for the 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 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

edit

Executing a 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:

client.indices().freezeAsync(request, RequestOptions.DEFAULT, listener);

The FreezeIndexRequest 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. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for freeze-index looks like:

ActionListener<ShardsAcknowledgedResponse> listener =
    new ActionListener<ShardsAcknowledgedResponse>() {
        @Override
        public void onResponse(ShardsAcknowledgedResponse freezeIndexResponse) {
            
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

	Called when the execution is successfully completed.
	Called when the whole `FreezeIndexRequest` fails.

Freeze Index Response

edit

The returned FreezeIndexResponse 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

« Get Index API Unfreeze Index API »

Was this helpful?

Feedback