Package co.elastic.clients.elasticsearch.slm

Class ElasticsearchSlmClient

java.lang.Object

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

co.elastic.clients.elasticsearch.slm.ElasticsearchSlmClient

All Implemented Interfaces:

Closeable, AutoCloseable

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

Constructors

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

Method Summary

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

ElasticsearchSlmClient

public ElasticsearchSlmClient(ElasticsearchTransport transport)

ElasticsearchSlmClient

public ElasticsearchSlmClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSlmClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSlmClient>

deleteLifecycle

public DeleteLifecycleResponse deleteLifecycle(DeleteLifecycleRequest request)
                                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteLifecycle

public final DeleteLifecycleResponse deleteLifecycle(Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeLifecycle

public ExecuteLifecycleResponse executeLifecycle(ExecuteLifecycleRequest request)
                                          throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeLifecycle

public final ExecuteLifecycleResponse executeLifecycle(Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> fn)
                                                throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeRetention

public ExecuteRetentionResponse executeRetention(ExecuteRetentionRequest request)
                                          throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeRetention

public final ExecuteRetentionResponse executeRetention(Function<ExecuteRetentionRequest.Builder,ObjectBuilder<ExecuteRetentionRequest>> fn)
                                                throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeRetention

public ExecuteRetentionResponse executeRetention()
                                          throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getLifecycle

public GetLifecycleResponse getLifecycle(GetLifecycleRequest request)
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getLifecycle

public final GetLifecycleResponse getLifecycle(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)
                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getLifecycle

public GetLifecycleResponse getLifecycle()
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStats

public GetStatsResponse getStats(GetStatsRequest request)
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStats

public final GetStatsResponse getStats(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)
                                throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStats

public GetStatsResponse getStats()
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStatus

public GetSlmStatusResponse getStatus(GetSlmStatusRequest request)
                               throws IOException,
ElasticsearchException

Get the snapshot lifecycle management status.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStatus

public final GetSlmStatusResponse getStatus(Function<GetSlmStatusRequest.Builder,ObjectBuilder<GetSlmStatusRequest>> fn)
                                     throws IOException,
ElasticsearchException

Get the snapshot lifecycle management status.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStatus

public GetSlmStatusResponse getStatus()
                               throws IOException,
ElasticsearchException

Get the snapshot lifecycle management status.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putLifecycle

public PutLifecycleResponse putLifecycle(PutLifecycleRequest request)
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putLifecycle

public final PutLifecycleResponse putLifecycle(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public StartSlmResponse start(StartSlmRequest request)
                       throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public final StartSlmResponse start(Function<StartSlmRequest.Builder,ObjectBuilder<StartSlmRequest>> fn)
                             throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public StartSlmResponse start()
                       throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public StopSlmResponse stop(StopSlmRequest request)
                     throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public final StopSlmResponse stop(Function<StopSlmRequest.Builder,ObjectBuilder<StopSlmRequest>> fn)
                           throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public StopSlmResponse stop()
                     throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co