Package co.elastic.clients.elasticsearch.slm

Class ElasticsearchSlmClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.slm.ElasticsearchSlmClient

public class ElasticsearchSlmClient
extends ApiClient

Client for the slm namespace.

Field Summary

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

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSlmClient(Transport transport)

Method Summary

Modifier and Type	Method	Description
DeleteLifecycleResponse	deleteLifecycle(DeleteLifecycleRequest request)	Deletes an existing snapshot lifecycle policy.
DeleteLifecycleResponse	deleteLifecycle(java.util.function.Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)	Deletes an existing snapshot lifecycle policy.
ExecuteLifecycleResponse	executeLifecycle(ExecuteLifecycleRequest request)	Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
ExecuteLifecycleResponse	executeLifecycle(java.util.function.Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> fn)	Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
ExecuteRetentionResponse	executeRetention()	Deletes any snapshots that are expired according to the policy's retention rules.
GetLifecycleResponse	getLifecycle(GetLifecycleRequest request)	Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
GetLifecycleResponse	getLifecycle(java.util.function.Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)	Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
GetStatsResponse	getStats()	Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
GetStatusResponse	getStatus()	Retrieves the status of snapshot lifecycle management (SLM).
PutLifecycleResponse	putLifecycle(PutLifecycleRequest request)	Creates or updates a snapshot lifecycle policy.
PutLifecycleResponse	putLifecycle(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)	Creates or updates a snapshot lifecycle policy.
StartResponse	start()	Turns on snapshot lifecycle management (SLM).
StopResponse	stop()	Turns off snapshot lifecycle management (SLM).

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

ElasticsearchSlmClient

public ElasticsearchSlmClient(Transport transport)

Method Details

deleteLifecycle

public DeleteLifecycleResponse deleteLifecycle(DeleteLifecycleRequest request)
                                        throws java.io.IOException

Deletes an existing snapshot lifecycle policy.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteLifecycle

public final DeleteLifecycleResponse deleteLifecycle(java.util.function.Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)
                                              throws java.io.IOException

Deletes an existing snapshot lifecycle policy.

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

executeLifecycle

public ExecuteLifecycleResponse executeLifecycle(ExecuteLifecycleRequest request)
                                          throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

executeLifecycle

public final ExecuteLifecycleResponse executeLifecycle(java.util.function.Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> fn)
                                                throws java.io.IOException

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

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

executeRetention

public ExecuteRetentionResponse executeRetention()
                                          throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getLifecycle

public GetLifecycleResponse getLifecycle(GetLifecycleRequest request)
                                  throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getLifecycle

public final GetLifecycleResponse getLifecycle(java.util.function.Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)
                                        throws java.io.IOException

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

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

getStats

public GetStatsResponse getStats()
                          throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getStatus

public GetStatusResponse getStatus()
                            throws java.io.IOException

Retrieves the status of snapshot lifecycle management (SLM).

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putLifecycle

public PutLifecycleResponse putLifecycle(PutLifecycleRequest request)
                                  throws java.io.IOException

Creates or updates a snapshot lifecycle policy.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putLifecycle

public final PutLifecycleResponse putLifecycle(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
                                        throws java.io.IOException

Creates or updates a snapshot lifecycle policy.

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

start

public StartResponse start()
                    throws java.io.IOException

Turns on snapshot lifecycle management (SLM).

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

stop

public StopResponse stop()
                  throws java.io.IOException

Turns off snapshot lifecycle management (SLM).

Throws:

java.io.IOException

See Also:

Documentation on elastic.co