Class ElasticsearchSlmClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSlmClient>
co.elastic.clients.elasticsearch.slm.ElasticsearchSlmClient
public class ElasticsearchSlmClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSlmClient>
Client for the slm namespace.
-
Field Summary
Fields inherited from class co.elastic.clients.ApiClient
transport, transportOptions
-
Constructor Summary
ConstructorDescriptionElasticsearchSlmClient
(ElasticsearchTransport transport) ElasticsearchSlmClient
(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptiondeleteLifecycle
(DeleteLifecycleRequest request) Deletes an existing snapshot lifecycle policy.final DeleteLifecycleResponse
Deletes an existing snapshot lifecycle policy.executeLifecycle
(ExecuteLifecycleRequest request) Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.final ExecuteLifecycleResponse
executeLifecycle
(Function<ExecuteLifecycleRequest.Builder, ObjectBuilder<ExecuteLifecycleRequest>> fn) Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.Deletes any snapshots that are expired according to the policy's retention rules.Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.getLifecycle
(GetLifecycleRequest request) Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.final GetLifecycleResponse
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.getStats()
Returns global and policy-level statistics about actions taken by snapshot lifecycle management.Retrieves the status of snapshot lifecycle management (SLM).putLifecycle
(PutLifecycleRequest request) Creates or updates a snapshot lifecycle policy.final PutLifecycleResponse
Creates or updates a snapshot lifecycle policy.start()
Turns on snapshot lifecycle management (SLM).stop()
Turns off snapshot lifecycle management (SLM).withTransportOptions
(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchSlmClient
-
ElasticsearchSlmClient
public ElasticsearchSlmClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,
ElasticsearchSlmClient>
-
deleteLifecycle
public DeleteLifecycleResponse deleteLifecycle(DeleteLifecycleRequest request) throws IOException, ElasticsearchException Deletes an existing snapshot lifecycle policy.- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteLifecycle
public final DeleteLifecycleResponse deleteLifecycle(Function<DeleteLifecycleRequest.Builder, ObjectBuilder<DeleteLifecycleRequest>> fn) throws IOException, ElasticsearchExceptionDeletes an existing snapshot lifecycle policy.- Parameters:
fn
- a function that initializes a builder to create theDeleteLifecycleRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
executeLifecycle
public ExecuteLifecycleResponse executeLifecycle(ExecuteLifecycleRequest request) throws IOException, ElasticsearchException Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.- Throws:
IOException
ElasticsearchException
- See Also:
-
executeLifecycle
public final ExecuteLifecycleResponse executeLifecycle(Function<ExecuteLifecycleRequest.Builder, ObjectBuilder<ExecuteLifecycleRequest>> fn) throws IOException, ElasticsearchExceptionImmediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.- Parameters:
fn
- a function that initializes a builder to create theExecuteLifecycleRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
executeRetention
Deletes any snapshots that are expired according to the policy's retention rules.- Throws:
IOException
ElasticsearchException
- See Also:
-
getLifecycle
public GetLifecycleResponse getLifecycle(GetLifecycleRequest request) throws IOException, ElasticsearchException Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.- Throws:
IOException
ElasticsearchException
- See Also:
-
getLifecycle
public final GetLifecycleResponse getLifecycle(Function<GetLifecycleRequest.Builder, ObjectBuilder<GetLifecycleRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.- Parameters:
fn
- a function that initializes a builder to create theGetLifecycleRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getLifecycle
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.- Throws:
IOException
ElasticsearchException
- See Also:
-
getStats
Returns global and policy-level statistics about actions taken by snapshot lifecycle management.- Throws:
IOException
ElasticsearchException
- See Also:
-
getStatus
Retrieves the status of snapshot lifecycle management (SLM).- Throws:
IOException
ElasticsearchException
- See Also:
-
putLifecycle
public PutLifecycleResponse putLifecycle(PutLifecycleRequest request) throws IOException, ElasticsearchException Creates or updates a snapshot lifecycle policy.- Throws:
IOException
ElasticsearchException
- See Also:
-
putLifecycle
public final PutLifecycleResponse putLifecycle(Function<PutLifecycleRequest.Builder, ObjectBuilder<PutLifecycleRequest>> fn) throws IOException, ElasticsearchExceptionCreates or updates a snapshot lifecycle policy.- Parameters:
fn
- a function that initializes a builder to create thePutLifecycleRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
start
Turns on snapshot lifecycle management (SLM).- Throws:
IOException
ElasticsearchException
- See Also:
-
stop
Turns off snapshot lifecycle management (SLM).- Throws:
IOException
ElasticsearchException
- See Also:
-