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
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PutLifecycleRequest.Builder
Builder forPutLifecycleRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<PutLifecycleRequest>
_DESERIALIZER
Json deserializer forPutLifecycleRequest
static Endpoint<PutLifecycleRequest,PutLifecycleResponse,ErrorResponse>
_ENDPOINT
Endpoint "slm.put_lifecycle
". -
Method Summary
Modifier and Type Method Description SlmConfiguration
config()
Configuration for each snapshot created by the policy.Time
masterTimeout()
Period to wait for a connection to the master node.java.lang.String
name()
Name automatically assigned to each snapshot created by the policy.static PutLifecycleRequest
of(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
java.lang.String
policyId()
Required - ID for the snapshot lifecycle policy you want to create or update.java.lang.String
repository()
Repository used to store snapshots created by this policy.Retention
retention()
Retention rules used to retain and delete snapshots created by the policy.java.lang.String
schedule()
Periodic or absolute schedule at which the policy creates snapshots.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupPutLifecycleRequestDeserializer(ObjectDeserializer<PutLifecycleRequest.Builder> op)
Time
timeout()
Period to wait for a response.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forPutLifecycleRequest
-
_ENDPOINT
Endpoint "slm.put_lifecycle
".
-
-
Method Details
-
of
public static PutLifecycleRequest of(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn) -
config
Configuration for each snapshot created by the policy.API name:
config
-
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
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
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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutLifecycleRequestDeserializer
protected static void setupPutLifecycleRequestDeserializer(ObjectDeserializer<PutLifecycleRequest.Builder> op)
-