Package org.opensearch.client.opensearch.api.snapshot

Class SnapshotAsyncClient

java.lang.Object

org.opensearch.client.base.ApiClient<SnapshotAsyncClient>

org.opensearch.client.opensearch.api.snapshot.SnapshotAsyncClient

public class SnapshotAsyncClient
extends ApiClient<SnapshotAsyncClient>

Client for the snapshot namespace.

Field Summary

Fields inherited from class org.opensearch.client.base.ApiClient

requestOptions, transport

Constructor Summary

Constructors

Constructor	Description
SnapshotAsyncClient(Transport transport)
SnapshotAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<CleanupRepositoryResponse>	cleanupRepository(java.util.function.Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn)	Removes stale data from repository.
java.util.concurrent.CompletableFuture<CleanupRepositoryResponse>	cleanupRepository(CleanupRepositoryRequest request)	Removes stale data from repository.
java.util.concurrent.CompletableFuture<CloneResponse>	clone(java.util.function.Function<CloneRequest.Builder,ObjectBuilder<CloneRequest>> fn)	Clones indices from one snapshot into another snapshot in the same repository.
java.util.concurrent.CompletableFuture<CloneResponse>	clone(CloneRequest request)	Clones indices from one snapshot into another snapshot in the same repository.
java.util.concurrent.CompletableFuture<CreateResponse>	create(java.util.function.Function<CreateRequest.Builder,ObjectBuilder<CreateRequest>> fn)	Creates a snapshot in a repository.
java.util.concurrent.CompletableFuture<CreateResponse>	create(CreateRequest request)	Creates a snapshot in a repository.
java.util.concurrent.CompletableFuture<CreateRepositoryResponse>	createRepository(java.util.function.Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)	Creates a repository.
java.util.concurrent.CompletableFuture<CreateRepositoryResponse>	createRepository(CreateRepositoryRequest request)	Creates a repository.
java.util.concurrent.CompletableFuture<DeleteResponse>	delete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Deletes a snapshot.
java.util.concurrent.CompletableFuture<DeleteResponse>	delete(DeleteRequest request)	Deletes a snapshot.
java.util.concurrent.CompletableFuture<DeleteRepositoryResponse>	deleteRepository(java.util.function.Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn)	Deletes a repository.
java.util.concurrent.CompletableFuture<DeleteRepositoryResponse>	deleteRepository(DeleteRepositoryRequest request)	Deletes a repository.
java.util.concurrent.CompletableFuture<GetResponse>	get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn)	Returns information about a snapshot.
java.util.concurrent.CompletableFuture<GetResponse>	get(GetRequest request)	Returns information about a snapshot.
java.util.concurrent.CompletableFuture<GetRepositoryResponse>	getRepository(java.util.function.Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)	Returns information about a repository.
java.util.concurrent.CompletableFuture<GetRepositoryResponse>	getRepository(GetRepositoryRequest request)	Returns information about a repository.
java.util.concurrent.CompletableFuture<RestoreResponse>	restore(java.util.function.Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn)	Restores a snapshot.
java.util.concurrent.CompletableFuture<RestoreResponse>	restore(RestoreRequest request)	Restores a snapshot.
java.util.concurrent.CompletableFuture<StatusResponse>	status(java.util.function.Function<StatusRequest.Builder,ObjectBuilder<StatusRequest>> fn)	Returns information about the status of a snapshot.
java.util.concurrent.CompletableFuture<StatusResponse>	status(StatusRequest request)	Returns information about the status of a snapshot.
java.util.concurrent.CompletableFuture<VerifyRepositoryResponse>	verifyRepository(java.util.function.Function<VerifyRepositoryRequest.Builder,ObjectBuilder<VerifyRepositoryRequest>> fn)	Verifies a repository.
java.util.concurrent.CompletableFuture<VerifyRepositoryResponse>	verifyRepository(VerifyRepositoryRequest request)	Verifies a repository.
SnapshotAsyncClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new SnapshotAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
SnapshotAsyncClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new SnapshotAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Methods inherited from class org.opensearch.client.base.ApiClient

getDeserializer, requestOptions

Methods inherited from class java.lang.Object

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

Constructor Details

SnapshotAsyncClient

public SnapshotAsyncClient(Transport transport)

SnapshotAsyncClient

public SnapshotAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Details

cleanupRepository

public java.util.concurrent.CompletableFuture<CleanupRepositoryResponse> cleanupRepository(CleanupRepositoryRequest request) throws java.io.IOException

Removes stale data from repository.

Throws:

java.io.IOException

cleanupRepository

public final java.util.concurrent.CompletableFuture<CleanupRepositoryResponse> cleanupRepository(java.util.function.Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn) throws java.io.IOException

Removes stale data from repository.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

clone

public java.util.concurrent.CompletableFuture<CloneResponse> clone(CloneRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

clone

public final java.util.concurrent.CompletableFuture<CloneResponse> clone(java.util.function.Function<CloneRequest.Builder,ObjectBuilder<CloneRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

create

public java.util.concurrent.CompletableFuture<CreateResponse> create(CreateRequest request) throws java.io.IOException

Creates a snapshot in a repository.

Throws:

java.io.IOException

create

public final java.util.concurrent.CompletableFuture<CreateResponse> create(java.util.function.Function<CreateRequest.Builder,ObjectBuilder<CreateRequest>> fn) throws java.io.IOException

Creates a snapshot in a repository.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

createRepository

public java.util.concurrent.CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest request) throws java.io.IOException

Creates a repository.

Throws:

java.io.IOException

createRepository

public final java.util.concurrent.CompletableFuture<CreateRepositoryResponse> createRepository(java.util.function.Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn) throws java.io.IOException

Creates a repository.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

delete

public java.util.concurrent.CompletableFuture<DeleteResponse> delete(DeleteRequest request) throws java.io.IOException

Deletes a snapshot.

Throws:

java.io.IOException

delete

public final java.util.concurrent.CompletableFuture<DeleteResponse> delete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn) throws java.io.IOException

Deletes a snapshot.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

deleteRepository

public java.util.concurrent.CompletableFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest request) throws java.io.IOException

Deletes a repository.

Throws:

java.io.IOException

deleteRepository

public final java.util.concurrent.CompletableFuture<DeleteRepositoryResponse> deleteRepository(java.util.function.Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn) throws java.io.IOException

Deletes a repository.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

get

public java.util.concurrent.CompletableFuture<GetResponse> get(GetRequest request) throws java.io.IOException

Returns information about a snapshot.

Throws:

java.io.IOException

get

public final java.util.concurrent.CompletableFuture<GetResponse> get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn) throws java.io.IOException

Returns information about a snapshot.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getRepository

public java.util.concurrent.CompletableFuture<GetRepositoryResponse> getRepository(GetRepositoryRequest request) throws java.io.IOException

Returns information about a repository.

Throws:

java.io.IOException

getRepository

public final java.util.concurrent.CompletableFuture<GetRepositoryResponse> getRepository(java.util.function.Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn) throws java.io.IOException

Returns information about a repository.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

restore

public java.util.concurrent.CompletableFuture<RestoreResponse> restore(RestoreRequest request) throws java.io.IOException

Restores a snapshot.

Throws:

java.io.IOException

restore

public final java.util.concurrent.CompletableFuture<RestoreResponse> restore(java.util.function.Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn) throws java.io.IOException

Restores a snapshot.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

status

public java.util.concurrent.CompletableFuture<StatusResponse> status(StatusRequest request) throws java.io.IOException

Returns information about the status of a snapshot.

Throws:

java.io.IOException

status

public final java.util.concurrent.CompletableFuture<StatusResponse> status(java.util.function.Function<StatusRequest.Builder,ObjectBuilder<StatusRequest>> fn) throws java.io.IOException

Returns information about the status of a snapshot.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

verifyRepository

public java.util.concurrent.CompletableFuture<VerifyRepositoryResponse> verifyRepository(VerifyRepositoryRequest request) throws java.io.IOException

Verifies a repository.

Throws:

java.io.IOException

verifyRepository

public final java.util.concurrent.CompletableFuture<VerifyRepositoryResponse> verifyRepository(java.util.function.Function<VerifyRepositoryRequest.Builder,ObjectBuilder<VerifyRepositoryRequest>> fn) throws java.io.IOException

Verifies a repository.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

withRequestOptions

public SnapshotAsyncClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

Creates a new SnapshotAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Specified by:

withRequestOptions in class ApiClient<SnapshotAsyncClient>

withRequestOptions

public SnapshotAsyncClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)

Creates a new SnapshotAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.

Parameters:

fn - a function taking an options builder initialized with the current request options, or initialized with default values.