Package org.opensearch.client.opensearch.snapshot

Class OpenSearchSnapshotAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.snapshot.OpenSearchSnapshotAsyncClient

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
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<CloneSnapshotResponse>	clone(java.util.function.Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)	Clones indices from one snapshot into another snapshot in the same repository.
java.util.concurrent.CompletableFuture<CloneSnapshotResponse>	clone(CloneSnapshotRequest request)	Clones indices from one snapshot into another snapshot in the same repository.
java.util.concurrent.CompletableFuture<CreateSnapshotResponse>	create(java.util.function.Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn)	Creates a snapshot in a repository.
java.util.concurrent.CompletableFuture<CreateSnapshotResponse>	create(CreateSnapshotRequest 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<DeleteSnapshotResponse>	delete(java.util.function.Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)	Deletes a snapshot.
java.util.concurrent.CompletableFuture<DeleteSnapshotResponse>	delete(DeleteSnapshotRequest 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<GetSnapshotResponse>	get(java.util.function.Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn)	Returns information about a snapshot.
java.util.concurrent.CompletableFuture<GetSnapshotResponse>	get(GetSnapshotRequest request)	Returns information about a snapshot.
java.util.concurrent.CompletableFuture<GetRepositoryResponse>	getRepository()	Returns information about a repository.
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<SnapshotStatusResponse>	status()	Returns information about the status of a snapshot.
java.util.concurrent.CompletableFuture<SnapshotStatusResponse>	status(java.util.function.Function<SnapshotStatusRequest.Builder,ObjectBuilder<SnapshotStatusRequest>> fn)	Returns information about the status of a snapshot.
java.util.concurrent.CompletableFuture<SnapshotStatusResponse>	status(SnapshotStatusRequest 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.
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 Detail

OpenSearchSnapshotAsyncClient

public OpenSearchSnapshotAsyncClient(OpenSearchTransport transport)

OpenSearchSnapshotAsyncClient

public OpenSearchSnapshotAsyncClient(OpenSearchTransport transport,
                                     @Nullable
                                     TransportOptions transportOptions)

Method Detail

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 java.util.concurrent.CompletableFuture<CleanupRepositoryResponse> cleanupRepository(CleanupRepositoryRequest request)
                                                                                    throws java.io.IOException,
                                                                                           OpenSearchException

Removes stale data from repository.

Throws:

java.io.IOException

OpenSearchException

cleanupRepository

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

Removes stale data from repository.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

clone

public java.util.concurrent.CompletableFuture<CloneSnapshotResponse> clone(CloneSnapshotRequest request)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

clone

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

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

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

create

public java.util.concurrent.CompletableFuture<CreateSnapshotResponse> create(CreateSnapshotRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Creates a snapshot in a repository.

Throws:

java.io.IOException

OpenSearchException

create

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

Creates a snapshot in a repository.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

createRepository

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

Creates a repository.

Throws:

java.io.IOException

OpenSearchException

createRepository

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

Creates a repository.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

delete

public java.util.concurrent.CompletableFuture<DeleteSnapshotResponse> delete(DeleteSnapshotRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Deletes a snapshot.

Throws:

java.io.IOException

OpenSearchException

delete

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

Deletes a snapshot.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteRepository

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

Deletes a repository.

Throws:

java.io.IOException

OpenSearchException

deleteRepository

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

Deletes a repository.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

get

public java.util.concurrent.CompletableFuture<GetSnapshotResponse> get(GetSnapshotRequest request)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Returns information about a snapshot.

Throws:

java.io.IOException

OpenSearchException

get

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

Returns information about a snapshot.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getRepository

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

Returns information about a repository.

Throws:

java.io.IOException

OpenSearchException

getRepository

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

Returns information about a repository.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getRepository

public java.util.concurrent.CompletableFuture<GetRepositoryResponse> getRepository()
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Returns information about a repository.

Throws:

java.io.IOException

OpenSearchException

restore

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

Restores a snapshot.

Throws:

java.io.IOException

OpenSearchException

restore

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

Restores a snapshot.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

status

public java.util.concurrent.CompletableFuture<SnapshotStatusResponse> status(SnapshotStatusRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns information about the status of a snapshot.

Throws:

java.io.IOException

OpenSearchException

status

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

Returns information about the status of a snapshot.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

status

public java.util.concurrent.CompletableFuture<SnapshotStatusResponse> status()
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Returns information about the status of a snapshot.

Throws:

java.io.IOException

OpenSearchException

verifyRepository

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

Verifies a repository.

Throws:

java.io.IOException

OpenSearchException

verifyRepository

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

Verifies a repository.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException