Package co.elastic.clients.elasticsearch.snapshot

Class ElasticsearchSnapshotClient

java.lang.Object

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

co.elastic.clients.elasticsearch.snapshot.ElasticsearchSnapshotClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSnapshotClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSnapshotClient>

Client for the snapshot namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CleanupRepositoryResponse	cleanupRepository(CleanupRepositoryRequest request)	Removes stale data from repository.
final CleanupRepositoryResponse	cleanupRepository(Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn)	Removes stale data from repository.
CloneSnapshotResponse	clone(CloneSnapshotRequest request)	Clones indices from one snapshot into another snapshot in the same repository.
final CloneSnapshotResponse	clone(Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)	Clones indices from one snapshot into another snapshot in the same repository.
CreateSnapshotResponse	create(CreateSnapshotRequest request)	Creates a snapshot in a repository.
final CreateSnapshotResponse	create(Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn)	Creates a snapshot in a repository.
CreateRepositoryResponse	createRepository(CreateRepositoryRequest request)	Creates a repository.
final CreateRepositoryResponse	createRepository(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)	Creates a repository.
DeleteSnapshotResponse	delete(DeleteSnapshotRequest request)	Deletes a snapshot.
final DeleteSnapshotResponse	delete(Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn)	Deletes a snapshot.
DeleteRepositoryResponse	deleteRepository(DeleteRepositoryRequest request)	Deletes a repository.
final DeleteRepositoryResponse	deleteRepository(Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn)	Deletes a repository.
GetSnapshotResponse	get(GetSnapshotRequest request)	Returns information about a snapshot.
final GetSnapshotResponse	get(Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn)	Returns information about a snapshot.
GetRepositoryResponse	getRepository()	Returns information about a repository.
GetRepositoryResponse	getRepository(GetRepositoryRequest request)	Returns information about a repository.
final GetRepositoryResponse	getRepository(Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn)	Returns information about a repository.
RestoreResponse	restore(RestoreRequest request)	Restores a snapshot.
final RestoreResponse	restore(Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn)	Restores a snapshot.
SnapshotStatusResponse	status()	Returns information about the status of a snapshot.
SnapshotStatusResponse	status(SnapshotStatusRequest request)	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.
VerifyRepositoryResponse	verifyRepository(VerifyRepositoryRequest request)	Verifies a repository.
final VerifyRepositoryResponse	verifyRepository(Function<VerifyRepositoryRequest.Builder,ObjectBuilder<VerifyRepositoryRequest>> fn)	Verifies a repository.
ElasticsearchSnapshotClient	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

ElasticsearchSnapshotClient

public ElasticsearchSnapshotClient(ElasticsearchTransport transport)

ElasticsearchSnapshotClient

public ElasticsearchSnapshotClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSnapshotClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSnapshotClient>

cleanupRepository

public CleanupRepositoryResponse cleanupRepository(CleanupRepositoryRequest request)
                                            throws IOException,
ElasticsearchException

Removes stale data from repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

cleanupRepository

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

Removes stale data from repository.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clone

public CloneSnapshotResponse clone(CloneSnapshotRequest request)
                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clone

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

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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

create

public CreateSnapshotResponse create(CreateSnapshotRequest request)
                              throws IOException,
ElasticsearchException

Creates a snapshot in a repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

create

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

Creates a snapshot in a repository.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createRepository

public CreateRepositoryResponse createRepository(CreateRepositoryRequest request)
                                          throws IOException,
ElasticsearchException

Creates a repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createRepository

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

Creates a repository.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public DeleteSnapshotResponse delete(DeleteSnapshotRequest request)
                              throws IOException,
ElasticsearchException

Deletes a snapshot.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

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

Deletes a snapshot.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRepository

public DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest request)
                                          throws IOException,
ElasticsearchException

Deletes a repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRepository

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

Deletes a repository.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetSnapshotResponse get(GetSnapshotRequest request)
                        throws IOException,
ElasticsearchException

Returns information about a snapshot.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

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

Returns information about a snapshot.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRepository

public GetRepositoryResponse getRepository(GetRepositoryRequest request)
                                    throws IOException,
ElasticsearchException

Returns information about a repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRepository

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

Returns information about a repository.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRepository

public GetRepositoryResponse getRepository()
                                    throws IOException,
ElasticsearchException

Returns information about a repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

restore

public RestoreResponse restore(RestoreRequest request)
                        throws IOException,
ElasticsearchException

Restores a snapshot.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

restore

public final RestoreResponse restore(Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn)
                              throws IOException,
ElasticsearchException

Restores a snapshot.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public SnapshotStatusResponse status(SnapshotStatusRequest request)
                              throws IOException,
ElasticsearchException

Returns information about the status of a snapshot.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

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

Returns information about the status of a snapshot.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

status

public SnapshotStatusResponse status()
                              throws IOException,
ElasticsearchException

Returns information about the status of a snapshot.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

verifyRepository

public VerifyRepositoryResponse verifyRepository(VerifyRepositoryRequest request)
                                          throws IOException,
ElasticsearchException

Verifies a repository.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

verifyRepository

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

Verifies a repository.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co