Class ElasticsearchSnapshotClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSnapshotClient>
co.elastic.clients.elasticsearch.snapshot.ElasticsearchSnapshotClient
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
Methods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
ElasticsearchSnapshotClient
-
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 classApiClient<ElasticsearchTransport,ElasticsearchSnapshotClient>
-
cleanupRepository
public CleanupRepositoryResponse cleanupRepository(CleanupRepositoryRequest request) throws java.io.IOException, ElasticsearchExceptionRemoves stale data from repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
cleanupRepository
public final CleanupRepositoryResponse cleanupRepository(java.util.function.Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn) throws java.io.IOException, ElasticsearchExceptionRemoves stale data from repository.- Parameters:
fn
- a function that initializes a builder to create theCleanupRepositoryRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
clone
public CloneSnapshotResponse clone(CloneSnapshotRequest request) throws java.io.IOException, ElasticsearchExceptionClones indices from one snapshot into another snapshot in the same repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
clone
public final CloneSnapshotResponse clone(java.util.function.Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn) throws java.io.IOException, ElasticsearchExceptionClones indices from one snapshot into another snapshot in the same repository.- Parameters:
fn
- a function that initializes a builder to create theCloneSnapshotRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
create
public CreateSnapshotResponse create(CreateSnapshotRequest request) throws java.io.IOException, ElasticsearchExceptionCreates a snapshot in a repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
create
public final CreateSnapshotResponse create(java.util.function.Function<CreateSnapshotRequest.Builder,ObjectBuilder<CreateSnapshotRequest>> fn) throws java.io.IOException, ElasticsearchExceptionCreates a snapshot in a repository.- Parameters:
fn
- a function that initializes a builder to create theCreateSnapshotRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
createRepository
public CreateRepositoryResponse createRepository(CreateRepositoryRequest request) throws java.io.IOException, ElasticsearchExceptionCreates a repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
createRepository
public final CreateRepositoryResponse createRepository(java.util.function.Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn) throws java.io.IOException, ElasticsearchExceptionCreates a repository.- Parameters:
fn
- a function that initializes a builder to create theCreateRepositoryRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
delete
public DeleteSnapshotResponse delete(DeleteSnapshotRequest request) throws java.io.IOException, ElasticsearchExceptionDeletes one or more snapshots.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
delete
public final DeleteSnapshotResponse delete(java.util.function.Function<DeleteSnapshotRequest.Builder,ObjectBuilder<DeleteSnapshotRequest>> fn) throws java.io.IOException, ElasticsearchExceptionDeletes one or more snapshots.- Parameters:
fn
- a function that initializes a builder to create theDeleteSnapshotRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteRepository
public DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest request) throws java.io.IOException, ElasticsearchExceptionDeletes a repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteRepository
public final DeleteRepositoryResponse deleteRepository(java.util.function.Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn) throws java.io.IOException, ElasticsearchExceptionDeletes a repository.- Parameters:
fn
- a function that initializes a builder to create theDeleteRepositoryRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
get
public GetSnapshotResponse get(GetSnapshotRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about a snapshot.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
get
public final GetSnapshotResponse get(java.util.function.Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about a snapshot.- Parameters:
fn
- a function that initializes a builder to create theGetSnapshotRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getRepository
public GetRepositoryResponse getRepository(GetRepositoryRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about a repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getRepository
public final GetRepositoryResponse getRepository(java.util.function.Function<GetRepositoryRequest.Builder,ObjectBuilder<GetRepositoryRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about a repository.- Parameters:
fn
- a function that initializes a builder to create theGetRepositoryRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getRepository
Returns information about a repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
restore
public RestoreResponse restore(RestoreRequest request) throws java.io.IOException, ElasticsearchExceptionRestores a snapshot.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
restore
public final RestoreResponse restore(java.util.function.Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn) throws java.io.IOException, ElasticsearchExceptionRestores a snapshot.- Parameters:
fn
- a function that initializes a builder to create theRestoreRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
status
public SnapshotStatusResponse status(SnapshotStatusRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about the status of a snapshot.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
status
public final SnapshotStatusResponse status(java.util.function.Function<SnapshotStatusRequest.Builder,ObjectBuilder<SnapshotStatusRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about the status of a snapshot.- Parameters:
fn
- a function that initializes a builder to create theSnapshotStatusRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
status
Returns information about the status of a snapshot.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
verifyRepository
public VerifyRepositoryResponse verifyRepository(VerifyRepositoryRequest request) throws java.io.IOException, ElasticsearchExceptionVerifies a repository.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
verifyRepository
public final VerifyRepositoryResponse verifyRepository(java.util.function.Function<VerifyRepositoryRequest.Builder,ObjectBuilder<VerifyRepositoryRequest>> fn) throws java.io.IOException, ElasticsearchExceptionVerifies a repository.- Parameters:
fn
- a function that initializes a builder to create theVerifyRepositoryRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-