Package co.elastic.clients.elasticsearch.slm

Class ElasticsearchSlmAsyncClient

java.lang.Object
co.elastic.clients.base.ApiClient
co.elastic.clients.elasticsearch.slm.ElasticsearchSlmAsyncClient
public class ElasticsearchSlmAsyncClient
extends ApiClient
Client for the slm namespace.

  • Constructor Details

    • ElasticsearchSlmAsyncClient

      public ElasticsearchSlmAsyncClient​(Transport transport)

  • Method Details

    • deleteLifecycle

      public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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

    • getLifecycle

      public java.util.concurrent.CompletableFuture<GetLifecycleResponse> getLifecycle() 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

    • getStats

      public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<StartSlmResponse> start() throws java.io.IOException
      Turns on snapshot lifecycle management (SLM).
      Throws:
      java.io.IOException
      See Also:
      Documentation on elastic.co

    • stop

      public java.util.concurrent.CompletableFuture<StopSlmResponse> stop() throws java.io.IOException
      Turns off snapshot lifecycle management (SLM).
      Throws:
      java.io.IOException
      See Also:
      Documentation on elastic.co