Package org.opensearch.client.opensearch.snapshot

Class OpenSearchSnapshotClient

java.lang.Object

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

org.opensearch.client.opensearch.snapshot.OpenSearchSnapshotClient

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

Client for the snapshot namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchSnapshotClient

public OpenSearchSnapshotClient(OpenSearchTransport transport)

OpenSearchSnapshotClient

public OpenSearchSnapshotClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchSnapshotClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchSnapshotClient>

cleanupRepository

public CleanupRepositoryResponse cleanupRepository(CleanupRepositoryRequest request)
                                            throws IOException,
OpenSearchException

Removes any stale data from a snapshot repository.

Throws:

IOException

OpenSearchException

cleanupRepository

public final 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 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 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 CreateSnapshotResponse create(CreateSnapshotRequest request)
                              throws IOException,
OpenSearchException

Creates a snapshot within an existing repository.

Throws:

IOException

OpenSearchException

create

public final 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 CreateRepositoryResponse createRepository(CreateRepositoryRequest request)
                                          throws IOException,
OpenSearchException

Creates a snapshot repository.

Throws:

IOException

OpenSearchException

createRepository

public final 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 DeleteSnapshotResponse delete(DeleteSnapshotRequest request)
                              throws IOException,
OpenSearchException

Deletes a snapshot.

Throws:

IOException

OpenSearchException

delete

public final 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 DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest request)
                                          throws IOException,
OpenSearchException

Deletes a snapshot repository.

Throws:

IOException

OpenSearchException

deleteRepository

public final 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 GetSnapshotResponse get(GetSnapshotRequest request)
                        throws IOException,
OpenSearchException

Returns information about a snapshot.

Throws:

IOException

OpenSearchException

get

public final 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 GetRepositoryResponse getRepository(GetRepositoryRequest request)
                                    throws IOException,
OpenSearchException

Returns information about a snapshot repository.

Throws:

IOException

OpenSearchException

getRepository

public final 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 GetRepositoryResponse getRepository()
                                          throws IOException,
OpenSearchException

Returns information about a snapshot repository.

Throws:

IOException

OpenSearchException

restore

public RestoreSnapshotResponse restore(RestoreSnapshotRequest request)
                                throws IOException,
OpenSearchException

Restores a snapshot.

Throws:

IOException

OpenSearchException

restore

public final 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 SnapshotStatusResponse status(SnapshotStatusRequest request)
                              throws IOException,
OpenSearchException

Returns information about the status of a snapshot.

Throws:

IOException

OpenSearchException

status

public final 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 SnapshotStatusResponse status()
                                    throws IOException,
OpenSearchException

Returns information about the status of a snapshot.

Throws:

IOException

OpenSearchException

verifyRepository

public VerifyRepositoryResponse verifyRepository(VerifyRepositoryRequest request)
                                          throws IOException,
OpenSearchException

Verifies a repository.

Throws:

IOException

OpenSearchException

verifyRepository

public final 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