Package co.elastic.clients.elasticsearch.snapshot

Class ElasticsearchSnapshotClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.snapshot.ElasticsearchSnapshotClient

public class ElasticsearchSnapshotClient
extends ApiClient

Client for the snapshot namespace.

Field Summary

Fields inherited from class co.elastic.clients.base.ApiClient

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSnapshotClient(Transport transport)

Method Summary

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

Methods inherited from class co.elastic.clients.base.ApiClient

_transport, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchSnapshotClient

public ElasticsearchSnapshotClient(Transport transport)

Method Details

cleanupRepository

public CleanupRepositoryResponse cleanupRepository(CleanupRepositoryRequest request)
                                            throws java.io.IOException

Removes stale data from repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

cleanupRepository

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

See Also:

Documentation on elastic.co

clone

public CloneSnapshotResponse clone(CloneSnapshotRequest request)
                            throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clone

public final CloneSnapshotResponse clone(java.util.function.Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> 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

See Also:

Documentation on elastic.co

create

public CreateSnapshotResponse create(CreateSnapshotRequest request)
                              throws java.io.IOException

Creates a snapshot in a repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

create

public final CreateSnapshotResponse create(java.util.function.Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> 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

See Also:

Documentation on elastic.co

createRepository

public CreateRepositoryResponse createRepository(CreateRepositoryRequest request)
                                          throws java.io.IOException

Creates a repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

createRepository

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

See Also:

Documentation on elastic.co

delete

public DeleteSnapshotResponse delete(DeleteSnapshotRequest request)
                              throws java.io.IOException

Deletes a snapshot.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

delete

public final DeleteSnapshotResponse delete(java.util.function.Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> 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

See Also:

Documentation on elastic.co

deleteRepository

public DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest request)
                                          throws java.io.IOException

Deletes a repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteRepository

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

See Also:

Documentation on elastic.co

get

public GetSnapshotResponse get(GetSnapshotRequest request)
                        throws java.io.IOException

Returns information about a snapshot.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

get

public final GetSnapshotResponse get(java.util.function.Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> 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

See Also:

Documentation on elastic.co

getRepository

public GetRepositoryResponse getRepository(GetRepositoryRequest request)
                                    throws java.io.IOException

Returns information about a repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRepository

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

See Also:

Documentation on elastic.co

getRepository

public GetRepositoryResponse getRepository()
                                    throws java.io.IOException

Returns information about a repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

restore

public RestoreResponse restore(RestoreRequest request)
                        throws java.io.IOException

Restores a snapshot.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

restore

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

See Also:

Documentation on elastic.co

status

public StatusResponse status(StatusRequest request)
                      throws java.io.IOException

Returns information about the status of a snapshot.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

status

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

See Also:

Documentation on elastic.co

status

public StatusResponse status()
                      throws java.io.IOException

Returns information about the status of a snapshot.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

verifyRepository

public VerifyRepositoryResponse verifyRepository(VerifyRepositoryRequest request)
                                          throws java.io.IOException

Verifies a repository.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

verifyRepository

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

See Also:

Documentation on elastic.co