Package co.elastic.clients.elasticsearch.snapshot

Class ElasticsearchSnapshotAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSnapshotAsyncClient>

co.elastic.clients.elasticsearch.snapshot.ElasticsearchSnapshotAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSnapshotAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSnapshotAsyncClient>

Client for the snapshot namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSnapshotAsyncClient(ElasticsearchTransport transport)
ElasticsearchSnapshotAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CleanupRepositoryResponse>	cleanupRepository(CleanupRepositoryRequest request)	Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.
final CompletableFuture<CleanupRepositoryResponse>	cleanupRepository(Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn)	Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.
CompletableFuture<CloneSnapshotResponse>	clone(CloneSnapshotRequest request)	Clones indices from one snapshot into another snapshot in the same repository.
final CompletableFuture<CloneSnapshotResponse>	clone(Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)	Clones indices from one snapshot into another snapshot in the same repository.
CompletableFuture<CreateSnapshotResponse>	create(CreateSnapshotRequest request)	Creates a snapshot in a repository.
final CompletableFuture<CreateSnapshotResponse>	create(Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn)	Creates a snapshot in a repository.
CompletableFuture<CreateRepositoryResponse>	createRepository(CreateRepositoryRequest request)	Creates a repository.
final CompletableFuture<CreateRepositoryResponse>	createRepository(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)	Creates a repository.
CompletableFuture<DeleteSnapshotResponse>	delete(DeleteSnapshotRequest request)	Deletes one or more snapshots.
final CompletableFuture<DeleteSnapshotResponse>	delete(Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)	Deletes one or more snapshots.
CompletableFuture<DeleteRepositoryResponse>	deleteRepository(DeleteRepositoryRequest request)	Deletes a repository.
final CompletableFuture<DeleteRepositoryResponse>	deleteRepository(Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn)	Deletes a repository.
CompletableFuture<GetSnapshotResponse>	get(GetSnapshotRequest request)	Returns information about a snapshot.
final CompletableFuture<GetSnapshotResponse>	get(Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn)	Returns information about a snapshot.
CompletableFuture<GetRepositoryResponse>	getRepository()	Returns information about a repository.
CompletableFuture<GetRepositoryResponse>	getRepository(GetRepositoryRequest request)	Returns information about a repository.
final CompletableFuture<GetRepositoryResponse>	getRepository(Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)	Returns information about a repository.
CompletableFuture<RepositoryVerifyIntegrityResponse>	repositoryVerifyIntegrity(RepositoryVerifyIntegrityRequest request)	Verifies the integrity of the contents of a snapshot repository
final CompletableFuture<RepositoryVerifyIntegrityResponse>	repositoryVerifyIntegrity(Function<RepositoryVerifyIntegrityRequest.Builder,ObjectBuilder<RepositoryVerifyIntegrityRequest>> fn)	Verifies the integrity of the contents of a snapshot repository
CompletableFuture<RestoreResponse>	restore(RestoreRequest request)	Restores a snapshot.
final CompletableFuture<RestoreResponse>	restore(Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn)	Restores a snapshot.
CompletableFuture<SnapshotStatusResponse>	status()	Returns information about the status of a snapshot.
CompletableFuture<SnapshotStatusResponse>	status(SnapshotStatusRequest request)	Returns information about the status of a snapshot.
final CompletableFuture<SnapshotStatusResponse>	status(Function<SnapshotStatusRequest.Builder,ObjectBuilder<SnapshotStatusRequest>> fn)	Returns information about the status of a snapshot.
CompletableFuture<VerifyRepositoryResponse>	verifyRepository(VerifyRepositoryRequest request)	Verifies a repository.
final CompletableFuture<VerifyRepositoryResponse>	verifyRepository(Function<VerifyRepositoryRequest.Builder,ObjectBuilder<VerifyRepositoryRequest>> fn)	Verifies a repository.
ElasticsearchSnapshotAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchSnapshotAsyncClient

public ElasticsearchSnapshotAsyncClient(ElasticsearchTransport transport)

ElasticsearchSnapshotAsyncClient

public ElasticsearchSnapshotAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSnapshotAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSnapshotAsyncClient>

cleanupRepository

public CompletableFuture<CleanupRepositoryResponse> cleanupRepository(CleanupRepositoryRequest request)

Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.

See Also:

• Documentation on elastic.co

cleanupRepository

public final CompletableFuture<CleanupRepositoryResponse> cleanupRepository(Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn)

Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.

Parameters:

fn - a function that initializes a builder to create the CleanupRepositoryRequest

See Also:

• Documentation on elastic.co

clone

public CompletableFuture<CloneSnapshotResponse> clone(CloneSnapshotRequest request)

Clones indices from one snapshot into another snapshot in the same repository.

See Also:

• Documentation on elastic.co

clone

public final CompletableFuture<CloneSnapshotResponse> clone(Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)

Clones indices from one snapshot into another snapshot in the same repository.

Parameters:

fn - a function that initializes a builder to create the CloneSnapshotRequest

See Also:

• Documentation on elastic.co

create

public CompletableFuture<CreateSnapshotResponse> create(CreateSnapshotRequest request)

Creates a snapshot in a repository.

See Also:

• Documentation on elastic.co

create

public final CompletableFuture<CreateSnapshotResponse> create(Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn)

Creates a snapshot in a repository.

Parameters:

fn - a function that initializes a builder to create the CreateSnapshotRequest

See Also:

• Documentation on elastic.co

createRepository

public CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest request)

Creates a repository.

See Also:

• Documentation on elastic.co

createRepository

public final CompletableFuture<CreateRepositoryResponse> createRepository(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)

Creates a repository.

Parameters:

fn - a function that initializes a builder to create the CreateRepositoryRequest

See Also:

• Documentation on elastic.co

delete

public CompletableFuture<DeleteSnapshotResponse> delete(DeleteSnapshotRequest request)

Deletes one or more snapshots.

See Also:

• Documentation on elastic.co

delete

public final CompletableFuture<DeleteSnapshotResponse> delete(Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)

Deletes one or more snapshots.

Parameters:

fn - a function that initializes a builder to create the DeleteSnapshotRequest

See Also:

• Documentation on elastic.co

deleteRepository

public CompletableFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest request)

Deletes a repository.

See Also:

• Documentation on elastic.co

deleteRepository

public final CompletableFuture<DeleteRepositoryResponse> deleteRepository(Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn)

Deletes a repository.

Parameters:

fn - a function that initializes a builder to create the DeleteRepositoryRequest

See Also:

• Documentation on elastic.co

get

public CompletableFuture<GetSnapshotResponse> get(GetSnapshotRequest request)

Returns information about a snapshot.

See Also:

• Documentation on elastic.co

get

public final CompletableFuture<GetSnapshotResponse> get(Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn)

Returns information about a snapshot.

Parameters:

fn - a function that initializes a builder to create the GetSnapshotRequest

See Also:

• Documentation on elastic.co

getRepository

public CompletableFuture<GetRepositoryResponse> getRepository(GetRepositoryRequest request)

Returns information about a repository.

See Also:

• Documentation on elastic.co

getRepository

public final CompletableFuture<GetRepositoryResponse> getRepository(Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)

Returns information about a repository.

Parameters:

fn - a function that initializes a builder to create the GetRepositoryRequest

See Also:

• Documentation on elastic.co

getRepository

public CompletableFuture<GetRepositoryResponse> getRepository()

Returns information about a repository.

See Also:

• Documentation on elastic.co

repositoryVerifyIntegrity

public CompletableFuture<RepositoryVerifyIntegrityResponse> repositoryVerifyIntegrity(RepositoryVerifyIntegrityRequest request)

Verifies the integrity of the contents of a snapshot repository

See Also:

• Documentation on elastic.co

repositoryVerifyIntegrity

public final CompletableFuture<RepositoryVerifyIntegrityResponse> repositoryVerifyIntegrity(Function<RepositoryVerifyIntegrityRequest.Builder,ObjectBuilder<RepositoryVerifyIntegrityRequest>> fn)

Verifies the integrity of the contents of a snapshot repository

Parameters:

fn - a function that initializes a builder to create the RepositoryVerifyIntegrityRequest

See Also:

• Documentation on elastic.co

restore

public CompletableFuture<RestoreResponse> restore(RestoreRequest request)

Restores a snapshot.

See Also:

• Documentation on elastic.co

restore

public final CompletableFuture<RestoreResponse> restore(Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn)

Restores a snapshot.

Parameters:

fn - a function that initializes a builder to create the RestoreRequest

See Also:

• Documentation on elastic.co

status

public CompletableFuture<SnapshotStatusResponse> status(SnapshotStatusRequest request)

Returns information about the status of a snapshot.

See Also:

• Documentation on elastic.co

status

public final CompletableFuture<SnapshotStatusResponse> status(Function<SnapshotStatusRequest.Builder,ObjectBuilder<SnapshotStatusRequest>> fn)

Returns information about the status of a snapshot.

Parameters:

fn - a function that initializes a builder to create the SnapshotStatusRequest

See Also:

• Documentation on elastic.co

status

public CompletableFuture<SnapshotStatusResponse> status()

Returns information about the status of a snapshot.

See Also:

• Documentation on elastic.co

verifyRepository

public CompletableFuture<VerifyRepositoryResponse> verifyRepository(VerifyRepositoryRequest request)

Verifies a repository.

See Also:

• Documentation on elastic.co

verifyRepository

public final CompletableFuture<VerifyRepositoryResponse> verifyRepository(Function<VerifyRepositoryRequest.Builder,ObjectBuilder<VerifyRepositoryRequest>> fn)

Verifies a repository.

Parameters:

fn - a function that initializes a builder to create the VerifyRepositoryRequest

See Also:

• Documentation on elastic.co