Package org.opensearch.client.opensearch.snapshot

Class OpenSearchSnapshotAsyncClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchSnapshotAsyncClient>

org.opensearch.client.opensearch.snapshot.OpenSearchSnapshotAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchSnapshotAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchSnapshotAsyncClient>

Client for the snapshot namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchSnapshotAsyncClient(OpenSearchTransport transport)
OpenSearchSnapshotAsyncClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<CleanupRepositoryResponse>	cleanupRepository(Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn)	Removes any stale data from a snapshot repository.
CompletableFuture<CleanupRepositoryResponse>	cleanupRepository(CleanupRepositoryRequest request)	Removes any stale data from a snapshot repository.
final CompletableFuture<CloneSnapshotResponse>	clone(Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)	Creates a clone of all or part of a snapshot in the same repository as the original snapshot.
CompletableFuture<CloneSnapshotResponse>	clone(CloneSnapshotRequest request)	Creates a clone of all or part of a snapshot in the same repository as the original snapshot.
final CompletableFuture<CreateSnapshotResponse>	create(Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn)	Creates a snapshot within an existing repository.
CompletableFuture<CreateSnapshotResponse>	create(CreateSnapshotRequest request)	Creates a snapshot within an existing repository.
final CompletableFuture<CreateRepositoryResponse>	createRepository(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)	Creates a snapshot repository.
CompletableFuture<CreateRepositoryResponse>	createRepository(CreateRepositoryRequest request)	Creates a snapshot repository.
final CompletableFuture<DeleteSnapshotResponse>	delete(Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)	Deletes a snapshot.
CompletableFuture<DeleteSnapshotResponse>	delete(DeleteSnapshotRequest request)	Deletes a snapshot.
final CompletableFuture<DeleteRepositoryResponse>	deleteRepository(Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn)	Deletes a snapshot repository.
CompletableFuture<DeleteRepositoryResponse>	deleteRepository(DeleteRepositoryRequest request)	Deletes a snapshot repository.
final CompletableFuture<GetSnapshotResponse>	get(Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn)	Returns information about a snapshot.
CompletableFuture<GetSnapshotResponse>	get(GetSnapshotRequest request)	Returns information about a snapshot.
final CompletableFuture<GetRepositoryResponse>	getRepository()	Returns information about a snapshot repository.
final CompletableFuture<GetRepositoryResponse>	getRepository(Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)	Returns information about a snapshot repository.
CompletableFuture<GetRepositoryResponse>	getRepository(GetRepositoryRequest request)	Returns information about a snapshot repository.
final CompletableFuture<RestoreSnapshotResponse>	restore(Function<RestoreSnapshotRequest.Builder,ObjectBuilder<RestoreSnapshotRequest>> fn)	Restores a snapshot.
CompletableFuture<RestoreSnapshotResponse>	restore(RestoreSnapshotRequest request)	Restores a snapshot.
final CompletableFuture<SnapshotStatusResponse>	status()	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<SnapshotStatusResponse>	status(SnapshotStatusRequest request)	Returns information about the status of a snapshot.
final CompletableFuture<VerifyRepositoryResponse>	verifyRepository(Function<VerifyRepositoryRequest.Builder,ObjectBuilder<VerifyRepositoryRequest>> fn)	Verifies a repository.
CompletableFuture<VerifyRepositoryResponse>	verifyRepository(VerifyRepositoryRequest request)	Verifies a repository.
OpenSearchSnapshotAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchSnapshotAsyncClient

public OpenSearchSnapshotAsyncClient(OpenSearchTransport transport)

OpenSearchSnapshotAsyncClient

public OpenSearchSnapshotAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchSnapshotAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchSnapshotAsyncClient>

cleanupRepository

public CompletableFuture<CleanupRepositoryResponse> cleanupRepository(CleanupRepositoryRequest request)
                                                               throws IOException,
OpenSearchException

Removes any stale data from a snapshot repository.

Throws:

IOException

OpenSearchException

cleanupRepository

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

Removes any stale data from a snapshot repository.

Parameters:

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

Throws:

IOException

OpenSearchException

clone

public CompletableFuture<CloneSnapshotResponse> clone(CloneSnapshotRequest request)
                                               throws IOException,
OpenSearchException

Creates a clone of all or part of a snapshot in the same repository as the original snapshot.

Throws:

IOException

OpenSearchException

clone

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

Creates a clone of all or part of a snapshot in the same repository as the original snapshot.

Parameters:

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

Throws:

IOException

OpenSearchException

create

public CompletableFuture<CreateSnapshotResponse> create(CreateSnapshotRequest request)
                                                 throws IOException,
OpenSearchException

Creates a snapshot within an existing repository.

Throws:

IOException

OpenSearchException

create

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

Creates a snapshot within an existing repository.

Parameters:

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

Throws:

IOException

OpenSearchException

createRepository

public CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest request)
                                                             throws IOException,
OpenSearchException

Creates a snapshot repository.

Throws:

IOException

OpenSearchException

createRepository

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

Creates a snapshot repository.

Parameters:

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

Throws:

IOException

OpenSearchException

delete

public CompletableFuture<DeleteSnapshotResponse> delete(DeleteSnapshotRequest request)
                                                 throws IOException,
OpenSearchException

Deletes a snapshot.

Throws:

IOException

OpenSearchException

delete

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

Deletes a snapshot.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteRepository

public CompletableFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest request)
                                                             throws IOException,
OpenSearchException

Deletes a snapshot repository.

Throws:

IOException

OpenSearchException

deleteRepository

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

Deletes a snapshot repository.

Parameters:

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

Throws:

IOException

OpenSearchException

get

public CompletableFuture<GetSnapshotResponse> get(GetSnapshotRequest request)
                                           throws IOException,
OpenSearchException

Returns information about a snapshot.

Throws:

IOException

OpenSearchException

get

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

Returns information about a snapshot.

Parameters:

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

Throws:

IOException

OpenSearchException

getRepository

public CompletableFuture<GetRepositoryResponse> getRepository(GetRepositoryRequest request)
                                                       throws IOException,
OpenSearchException

Returns information about a snapshot repository.

Throws:

IOException

OpenSearchException

getRepository

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

Returns information about a snapshot repository.

Parameters:

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

Throws:

IOException

OpenSearchException

getRepository

public final CompletableFuture<GetRepositoryResponse> getRepository()
                                                             throws IOException,
OpenSearchException

Returns information about a snapshot repository.

Throws:

IOException

OpenSearchException

restore

public CompletableFuture<RestoreSnapshotResponse> restore(RestoreSnapshotRequest request)
                                                   throws IOException,
OpenSearchException

Restores a snapshot.

Throws:

IOException

OpenSearchException

restore

public final CompletableFuture<RestoreSnapshotResponse> restore(Function<RestoreSnapshotRequest.Builder,ObjectBuilder<RestoreSnapshotRequest>> fn)
                                                         throws IOException,
OpenSearchException

Restores a snapshot.

Parameters:

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

Throws:

IOException

OpenSearchException

status

public CompletableFuture<SnapshotStatusResponse> status(SnapshotStatusRequest request)
                                                 throws IOException,
OpenSearchException

Returns information about the status of a snapshot.

Throws:

IOException

OpenSearchException

status

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

Returns information about the status of a snapshot.

Parameters:

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

Throws:

IOException

OpenSearchException

status

public final CompletableFuture<SnapshotStatusResponse> status()
                                                       throws IOException,
OpenSearchException

Returns information about the status of a snapshot.

Throws:

IOException

OpenSearchException

verifyRepository

public CompletableFuture<VerifyRepositoryResponse> verifyRepository(VerifyRepositoryRequest request)
                                                             throws IOException,
OpenSearchException

Verifies a repository.

Throws:

IOException

OpenSearchException

verifyRepository

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

Verifies a repository.

Parameters:

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

Throws:

IOException

OpenSearchException