Class Retention
java.lang.Object
co.elastic.clients.elasticsearch.slm.Retention
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<Retention>
Json deserializer forRetention
-
Method Summary
Modifier and TypeMethodDescriptionfinal Time
Required - Time period after which a snapshot is considered expired and eligible for deletion.final int
maxCount()
Required - Maximum number of snapshots to retain, even if the snapshots have not yet expired.final int
minCount()
Required - Minimum number of snapshots to retain, even if the snapshots have expired.static Retention
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
toString()
-
Field Details
-
_DESERIALIZER
Json deserializer forRetention
-
-
Method Details
-
of
-
expireAfter
Required - Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule.API name:
expire_after
-
maxCount
public final int maxCount()Required - Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots.API name:
max_count
-
minCount
public final int minCount()Required - Minimum number of snapshots to retain, even if the snapshots have expired.API name:
min_count
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupRetentionDeserializer
-