Package co.elastic.clients.elasticsearch.slm

Class ElasticsearchSlmAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.slm.ElasticsearchSlmAsyncClient

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)	Deletes an existing snapshot lifecycle policy.
final CompletableFuture<DeleteLifecycleResponse>	deleteLifecycle(Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)	Deletes an existing snapshot lifecycle policy.
CompletableFuture<ExecuteLifecycleResponse>	executeLifecycle(ExecuteLifecycleRequest request)	Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
final CompletableFuture<ExecuteLifecycleResponse>	executeLifecycle(Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> fn)	Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
CompletableFuture<ExecuteRetentionResponse>	executeRetention()	Deletes any snapshots that are expired according to the policy's retention rules.
CompletableFuture<GetLifecycleResponse>	getLifecycle()	Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
CompletableFuture<GetLifecycleResponse>	getLifecycle(GetLifecycleRequest request)	Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
final CompletableFuture<GetLifecycleResponse>	getLifecycle(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)	Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
CompletableFuture<GetStatsResponse>	getStats()	Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
CompletableFuture<GetSlmStatusResponse>	getStatus()	Retrieves the status of snapshot lifecycle management (SLM).
CompletableFuture<PutLifecycleResponse>	putLifecycle(PutLifecycleRequest request)	Creates or updates a snapshot lifecycle policy.
final CompletableFuture<PutLifecycleResponse>	putLifecycle(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)	Creates or updates a snapshot lifecycle policy.
CompletableFuture<StartSlmResponse>	start()	Turns on snapshot lifecycle management (SLM).
CompletableFuture<StopSlmResponse>	stop()	Turns off snapshot lifecycle management (SLM).
ElasticsearchSlmAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, 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)

Deletes an existing snapshot lifecycle policy.

See Also:

• Documentation on elastic.co

deleteLifecycle

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

Deletes an existing snapshot lifecycle policy.

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)

Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.

See Also:

• Documentation on elastic.co

executeLifecycle

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

Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.

Parameters:

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

See Also:

• Documentation on elastic.co

executeRetention

public CompletableFuture<ExecuteRetentionResponse> executeRetention()

Deletes any snapshots that are expired according to the policy's retention rules.

See Also:

• Documentation on elastic.co

getLifecycle

public CompletableFuture<GetLifecycleResponse> getLifecycle(GetLifecycleRequest request)

Retrieves one or more 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)

Retrieves one or more 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()

Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.

See Also:

• Documentation on elastic.co

getStats

public CompletableFuture<GetStatsResponse> getStats()

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

See Also:

• Documentation on elastic.co

getStatus

public CompletableFuture<GetSlmStatusResponse> getStatus()

Retrieves the status of snapshot lifecycle management (SLM).

See Also:

• Documentation on elastic.co

putLifecycle

public CompletableFuture<PutLifecycleResponse> putLifecycle(PutLifecycleRequest request)

Creates or updates a snapshot lifecycle policy.

See Also:

• Documentation on elastic.co

putLifecycle

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

Creates or updates a snapshot lifecycle policy.

Parameters:

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

See Also:

• Documentation on elastic.co

start

public CompletableFuture<StartSlmResponse> start()

Turns on snapshot lifecycle management (SLM).

See Also:

• Documentation on elastic.co

stop

public CompletableFuture<StopSlmResponse> stop()

Turns off snapshot lifecycle management (SLM).

See Also:

• Documentation on elastic.co