Package co.elastic.clients.elasticsearch.slm

Class PutLifecycleRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.slm.PutLifecycleRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutLifecycleRequest
extends RequestBase
implements JsonpSerializable
Creates or updates a snapshot lifecycle policy.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static PutLifecycleRequest of​(java.util.function.Function<PutLifecycleRequest.Builder,​ObjectBuilder<PutLifecycleRequest>> fn)

    • config

      @Nullable public final SlmConfiguration config()
      Configuration for each snapshot created by the policy.

      API name: config

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • name

      @Nullable public final java.lang.String name()
      Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.

      API name: name

    • policyId

      public final java.lang.String policyId()
      Required - ID for the snapshot lifecycle policy you want to create or update.

      API name: policy_id

    • repository

      @Nullable public final java.lang.String repository()
      Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.

      API name: repository

    • retention

      @Nullable public final Retention retention()
      Retention rules used to retain and delete snapshots created by the policy.

      API name: retention

    • schedule

      @Nullable public final java.lang.String schedule()
      Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.

      API name: schedule

    • timeout

      @Nullable public final Time timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupPutLifecycleRequestDeserializer

      protected static void setupPutLifecycleRequestDeserializer​(ObjectDeserializer<PutLifecycleRequest.Builder> op)