Package org.elasticsearch.client

Class SnapshotClient

java.lang.Object

org.elasticsearch.client.SnapshotClient

public final class SnapshotClient
extends java.lang.Object

A wrapper for the RestHighLevelClient that provides methods for accessing the Snapshot API.

See Snapshot API on elastic.co

Method Summary

Modifier and Type	Method	Description
CleanupRepositoryResponse	cleanupRepository(CleanupRepositoryRequest cleanupRepositoryRequest, RequestOptions options)	Cleans up a snapshot repository.
Cancellable	cleanupRepositoryAsync(CleanupRepositoryRequest cleanupRepositoryRequest, RequestOptions options, ActionListener<CleanupRepositoryResponse> listener)	Asynchronously cleans up a snapshot repository.
CreateSnapshotResponse	create(CreateSnapshotRequest createSnapshotRequest, RequestOptions options)	Creates a snapshot.
Cancellable	createAsync(CreateSnapshotRequest createSnapshotRequest, RequestOptions options, ActionListener<CreateSnapshotResponse> listener)	Asynchronously creates a snapshot.
AcknowledgedResponse	createRepository(PutRepositoryRequest putRepositoryRequest, RequestOptions options)	Creates a snapshot repository.
Cancellable	createRepositoryAsync(PutRepositoryRequest putRepositoryRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously creates a snapshot repository.
AcknowledgedResponse	delete(DeleteSnapshotRequest deleteSnapshotRequest, RequestOptions options)	Deletes a snapshot.
Cancellable	deleteAsync(DeleteSnapshotRequest deleteSnapshotRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously deletes a snapshot.
AcknowledgedResponse	deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest, RequestOptions options)	Deletes a snapshot repository.
Cancellable	deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously deletes a snapshot repository.
GetSnapshotsResponse	get(GetSnapshotsRequest getSnapshotsRequest, RequestOptions options)	Get snapshots.
Cancellable	getAsync(GetSnapshotsRequest getSnapshotsRequest, RequestOptions options, ActionListener<GetSnapshotsResponse> listener)	Asynchronously get snapshots.
GetRepositoriesResponse	getRepository(GetRepositoriesRequest getRepositoriesRequest, RequestOptions options)	Gets a list of snapshot repositories.
Cancellable	getRepositoryAsync(GetRepositoriesRequest getRepositoriesRequest, RequestOptions options, ActionListener<GetRepositoriesResponse> listener)	Asynchronously gets a list of snapshot repositories.
RestoreSnapshotResponse	restore(RestoreSnapshotRequest restoreSnapshotRequest, RequestOptions options)	Restores a snapshot.
Cancellable	restoreAsync(RestoreSnapshotRequest restoreSnapshotRequest, RequestOptions options, ActionListener<RestoreSnapshotResponse> listener)	Asynchronously restores a snapshot.
SnapshotsStatusResponse	status(SnapshotsStatusRequest snapshotsStatusRequest, RequestOptions options)	Gets the status of requested snapshots.
Cancellable	statusAsync(SnapshotsStatusRequest snapshotsStatusRequest, RequestOptions options, ActionListener<SnapshotsStatusResponse> listener)	Asynchronously gets the status of requested snapshots.
VerifyRepositoryResponse	verifyRepository(VerifyRepositoryRequest verifyRepositoryRequest, RequestOptions options)	Verifies a snapshot repository.
Cancellable	verifyRepositoryAsync(VerifyRepositoryRequest verifyRepositoryRequest, RequestOptions options, ActionListener<VerifyRepositoryResponse> listener)	Asynchronously verifies a snapshot repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getRepository

public GetRepositoriesResponse getRepository(GetRepositoriesRequest getRepositoriesRequest, RequestOptions options) throws java.io.IOException

Gets a list of snapshot repositories. If the list of repositories is empty or it contains a single element "_all", all registered repositories are returned. See Snapshot and Restore API on elastic.co

Parameters:

getRepositoriesRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getRepositoryAsync

public Cancellable getRepositoryAsync(GetRepositoriesRequest getRepositoriesRequest, RequestOptions options, ActionListener<GetRepositoriesResponse> listener)

Asynchronously gets a list of snapshot repositories. If the list of repositories is empty or it contains a single element "_all", all registered repositories are returned. See Snapshot and Restore API on elastic.co

Parameters:

getRepositoriesRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

createRepository

public AcknowledgedResponse createRepository(PutRepositoryRequest putRepositoryRequest, RequestOptions options) throws java.io.IOException

Creates a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

putRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

createRepositoryAsync

public Cancellable createRepositoryAsync(PutRepositoryRequest putRepositoryRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)

Asynchronously creates a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

putRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deleteRepository

public AcknowledgedResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest, RequestOptions options) throws java.io.IOException

Deletes a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

deleteRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

deleteRepositoryAsync

public Cancellable deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)

Asynchronously deletes a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

deleteRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

verifyRepository

public VerifyRepositoryResponse verifyRepository(VerifyRepositoryRequest verifyRepositoryRequest, RequestOptions options) throws java.io.IOException

Verifies a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

verifyRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

verifyRepositoryAsync

public Cancellable verifyRepositoryAsync(VerifyRepositoryRequest verifyRepositoryRequest, RequestOptions options, ActionListener<VerifyRepositoryResponse> listener)

Asynchronously verifies a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

verifyRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

cleanupRepository

public CleanupRepositoryResponse cleanupRepository(CleanupRepositoryRequest cleanupRepositoryRequest, RequestOptions options) throws java.io.IOException

Cleans up a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

cleanupRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

cleanupRepositoryAsync

public Cancellable cleanupRepositoryAsync(CleanupRepositoryRequest cleanupRepositoryRequest, RequestOptions options, ActionListener<CleanupRepositoryResponse> listener)

Asynchronously cleans up a snapshot repository. See Snapshot and Restore API on elastic.co

Parameters:

cleanupRepositoryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

create

public CreateSnapshotResponse create(CreateSnapshotRequest createSnapshotRequest, RequestOptions options) throws java.io.IOException

Creates a snapshot.

See Snapshot and Restore API on elastic.co

Throws:

java.io.IOException

createAsync

public Cancellable createAsync(CreateSnapshotRequest createSnapshotRequest, RequestOptions options, ActionListener<CreateSnapshotResponse> listener)

Asynchronously creates a snapshot.

See Snapshot and Restore API on elastic.co

Returns:

cancellable that may be used to cancel the request

get

public GetSnapshotsResponse get(GetSnapshotsRequest getSnapshotsRequest, RequestOptions options) throws java.io.IOException

Get snapshots. See Snapshot and Restore API on elastic.co

Parameters:

getSnapshotsRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getAsync

public Cancellable getAsync(GetSnapshotsRequest getSnapshotsRequest, RequestOptions options, ActionListener<GetSnapshotsResponse> listener)

Asynchronously get snapshots. See Snapshot and Restore API on elastic.co

Parameters:

getSnapshotsRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

status

public SnapshotsStatusResponse status(SnapshotsStatusRequest snapshotsStatusRequest, RequestOptions options) throws java.io.IOException

Gets the status of requested snapshots. See Snapshot and Restore API on elastic.co

Parameters:

snapshotsStatusRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

statusAsync

public Cancellable statusAsync(SnapshotsStatusRequest snapshotsStatusRequest, RequestOptions options, ActionListener<SnapshotsStatusResponse> listener)

Asynchronously gets the status of requested snapshots. See Snapshot and Restore API on elastic.co

Parameters:

snapshotsStatusRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

restore

public RestoreSnapshotResponse restore(RestoreSnapshotRequest restoreSnapshotRequest, RequestOptions options) throws java.io.IOException

Restores a snapshot. See Snapshot and Restore API on elastic.co

Parameters:

restoreSnapshotRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

restoreAsync

public Cancellable restoreAsync(RestoreSnapshotRequest restoreSnapshotRequest, RequestOptions options, ActionListener<RestoreSnapshotResponse> listener)

Asynchronously restores a snapshot. See Snapshot and Restore API on elastic.co

Parameters:

restoreSnapshotRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

delete

public AcknowledgedResponse delete(DeleteSnapshotRequest deleteSnapshotRequest, RequestOptions options) throws java.io.IOException

Deletes a snapshot. See Snapshot and Restore API on elastic.co

Parameters:

deleteSnapshotRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

deleteAsync

public Cancellable deleteAsync(DeleteSnapshotRequest deleteSnapshotRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)

Asynchronously deletes a snapshot. See Snapshot and Restore API on elastic.co

Parameters:

deleteSnapshotRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request