New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Snapshot Delete Repository API Create Snapshot API »
Elastic Docs ›Java REST Client [6.4] ›Java High Level REST Client ›Snapshot APIs

Snapshot Verify Repository API

edit

Snapshot Verify Repository API

edit

The Snapshot Verify Repository API allows to verify a registered repository.

Snapshot Verify Repository Request

edit

A VerifyRepositoryRequest:

VerifyRepositoryRequest request = new VerifyRepositoryRequest(repositoryName);

Optional Arguments

edit

The following arguments can optionally be provided:

request.timeout(TimeValue.timeValueMinutes(1)); 
request.timeout("1m");

Timeout to wait for the all the nodes to acknowledge the settings were applied as a TimeValue

Timeout to wait for the all the nodes to acknowledge the settings were applied 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

Synchronous Execution

edit
VerifyRepositoryResponse response = client.snapshot().verifyRepository(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of a snapshot verify repository requires both the VerifyRepositoryRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.snapshot().verifyRepositoryAsync(request, RequestOptions.DEFAULT, listener);

The VerifyRepositoryRequest 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 VerifyRepositoryResponse looks like:

ActionListener<VerifyRepositoryResponse> listener =
    new ActionListener<VerifyRepositoryResponse>() {
        @Override
        public void onResponse(VerifyRepositoryResponse verifyRepositoryRestResponse) {
            
        }

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

Called when the execution is successfully completed. The response is provided as an argument

Called in case of a failure. The raised exception is provided as an argument

Snapshot Verify Repository Response

edit

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

List<VerifyRepositoryResponse.NodeView> repositoryMetaDataResponse = response.getNodes();
« Snapshot Delete Repository API Create Snapshot API »