Package co.elastic.clients.elasticsearch.slm

Class ElasticsearchSlmAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.slm.ElasticsearchSlmAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSlmAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSlmAsyncClient>

Client for the slm namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeleteLifecycleResponse>	deleteLifecycle(DeleteLifecycleRequest request)	Delete a policy.
final CompletableFuture<DeleteLifecycleResponse>	deleteLifecycle(Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)	Delete a policy.
CompletableFuture<ExecuteLifecycleResponse>	executeLifecycle(ExecuteLifecycleRequest request)	Run a policy.
final CompletableFuture<ExecuteLifecycleResponse>	executeLifecycle(Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> fn)	Run a policy.
CompletableFuture<ExecuteRetentionResponse>	executeRetention()	Run a retention policy.
CompletableFuture<ExecuteRetentionResponse>	executeRetention(ExecuteRetentionRequest request)	Run a retention policy.
final CompletableFuture<ExecuteRetentionResponse>	executeRetention(Function<ExecuteRetentionRequest.Builder,ObjectBuilder<ExecuteRetentionRequest>> fn)	Run a retention policy.
CompletableFuture<GetLifecycleResponse>	getLifecycle()	Get policy information.
CompletableFuture<GetLifecycleResponse>	getLifecycle(GetLifecycleRequest request)	Get policy information.
final CompletableFuture<GetLifecycleResponse>	getLifecycle(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)	Get policy information.
CompletableFuture<GetStatsResponse>	getStats()	Get snapshot lifecycle management statistics.
CompletableFuture<GetStatsResponse>	getStats(GetStatsRequest request)	Get snapshot lifecycle management statistics.
final CompletableFuture<GetStatsResponse>	getStats(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)	Get snapshot lifecycle management statistics.
CompletableFuture<GetSlmStatusResponse>	getStatus()	Get the snapshot lifecycle management status.
CompletableFuture<GetSlmStatusResponse>	getStatus(GetSlmStatusRequest request)	Get the snapshot lifecycle management status.
final CompletableFuture<GetSlmStatusResponse>	getStatus(Function<GetSlmStatusRequest.Builder,ObjectBuilder<GetSlmStatusRequest>> fn)	Get the snapshot lifecycle management status.
CompletableFuture<PutLifecycleResponse>	putLifecycle(PutLifecycleRequest request)	Create or update a policy.
final CompletableFuture<PutLifecycleResponse>	putLifecycle(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)	Create or update a policy.
CompletableFuture<StartSlmResponse>	start()	Start snapshot lifecycle management.
CompletableFuture<StartSlmResponse>	start(StartSlmRequest request)	Start snapshot lifecycle management.
final CompletableFuture<StartSlmResponse>	start(Function<StartSlmRequest.Builder,ObjectBuilder<StartSlmRequest>> fn)	Start snapshot lifecycle management.
CompletableFuture<StopSlmResponse>	stop()	Stop snapshot lifecycle management.
CompletableFuture<StopSlmResponse>	stop(StopSlmRequest request)	Stop snapshot lifecycle management.
final CompletableFuture<StopSlmResponse>	stop(Function<StopSlmRequest.Builder,ObjectBuilder<StopSlmRequest>> fn)	Stop snapshot lifecycle management.
ElasticsearchSlmAsyncClient	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

ElasticsearchSlmAsyncClient

public ElasticsearchSlmAsyncClient(ElasticsearchTransport transport)

ElasticsearchSlmAsyncClient

public ElasticsearchSlmAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSlmAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSlmAsyncClient>

deleteLifecycle

public CompletableFuture<DeleteLifecycleResponse> deleteLifecycle(DeleteLifecycleRequest request)

Delete a policy. Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.

See Also:

• Documentation on elastic.co

deleteLifecycle

public final CompletableFuture<DeleteLifecycleResponse> deleteLifecycle(Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)

Delete a policy. Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.

Parameters:

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

See Also:

• Documentation on elastic.co

executeLifecycle

public CompletableFuture<ExecuteLifecycleResponse> executeLifecycle(ExecuteLifecycleRequest request)

Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.

See Also:

• Documentation on elastic.co

executeLifecycle

public final CompletableFuture<ExecuteLifecycleResponse> executeLifecycle(Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> fn)

Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.

Parameters:

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

See Also:

• Documentation on elastic.co

executeRetention

public CompletableFuture<ExecuteRetentionResponse> executeRetention(ExecuteRetentionRequest request)

Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule.

See Also:

• Documentation on elastic.co

executeRetention

public final CompletableFuture<ExecuteRetentionResponse> executeRetention(Function<ExecuteRetentionRequest.Builder,ObjectBuilder<ExecuteRetentionRequest>> fn)

Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule.

Parameters:

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

See Also:

• Documentation on elastic.co

executeRetention

public CompletableFuture<ExecuteRetentionResponse> executeRetention()

Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule.

See Also:

• Documentation on elastic.co

getLifecycle

public CompletableFuture<GetLifecycleResponse> getLifecycle(GetLifecycleRequest request)

Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

See Also:

• Documentation on elastic.co

getLifecycle

public final CompletableFuture<GetLifecycleResponse> getLifecycle(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)

Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

Parameters:

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

See Also:

• Documentation on elastic.co

getLifecycle

public CompletableFuture<GetLifecycleResponse> getLifecycle()

Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

See Also:

• Documentation on elastic.co

getStats

public CompletableFuture<GetStatsResponse> getStats(GetStatsRequest request)

Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management.

See Also:

• Documentation on elastic.co

getStats

public final CompletableFuture<GetStatsResponse> getStats(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)

Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management.

Parameters:

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

See Also:

• Documentation on elastic.co

getStats

public CompletableFuture<GetStatsResponse> getStats()

Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management.

See Also:

• Documentation on elastic.co

getStatus

public CompletableFuture<GetSlmStatusResponse> getStatus(GetSlmStatusRequest request)

Get the snapshot lifecycle management status.

See Also:

• Documentation on elastic.co

getStatus

public final CompletableFuture<GetSlmStatusResponse> getStatus(Function<GetSlmStatusRequest.Builder,ObjectBuilder<GetSlmStatusRequest>> fn)

Get the snapshot lifecycle management status.

Parameters:

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

See Also:

• Documentation on elastic.co

getStatus

public CompletableFuture<GetSlmStatusResponse> getStatus()

Get the snapshot lifecycle management status.

See Also:

• Documentation on elastic.co

putLifecycle

public CompletableFuture<PutLifecycleResponse> putLifecycle(PutLifecycleRequest request)

Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored.

See Also:

• Documentation on elastic.co

putLifecycle

public final CompletableFuture<PutLifecycleResponse> putLifecycle(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)

Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored.

Parameters:

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

See Also:

• Documentation on elastic.co

start

public CompletableFuture<StartSlmResponse> start(StartSlmRequest request)

Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

See Also:

• Documentation on elastic.co

start

public final CompletableFuture<StartSlmResponse> start(Function<StartSlmRequest.Builder,ObjectBuilder<StartSlmRequest>> fn)

Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

Parameters:

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

See Also:

• Documentation on elastic.co

start

public CompletableFuture<StartSlmResponse> start()

Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

See Also:

• Documentation on elastic.co

stop

public CompletableFuture<StopSlmResponse> stop(StopSlmRequest request)

Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.

The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running.

See Also:

• Documentation on elastic.co

stop

public final CompletableFuture<StopSlmResponse> stop(Function<StopSlmRequest.Builder,ObjectBuilder<StopSlmRequest>> fn)

Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.

The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running.

Parameters:

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

See Also:

• Documentation on elastic.co

stop

public CompletableFuture<StopSlmResponse> stop()

Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.

The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running.

See Also:

• Documentation on elastic.co