Class Retention.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.slm.Retention.Builder
- All Implemented Interfaces:
ObjectBuilder<Retention>
- Enclosing class:
- Retention
public static class Retention.Builder extends ObjectBuilderBase implements ObjectBuilder<Retention>
Builder for
Retention
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description Retention
build()
Builds aRetention
.Retention.Builder
expireAfter(Time value)
Required - Time period after which a snapshot is considered expired and eligible for deletion.Retention.Builder
expireAfter(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Required - Time period after which a snapshot is considered expired and eligible for deletion.Retention.Builder
maxCount(int value)
Required - Maximum number of snapshots to retain, even if the snapshots have not yet expired.Retention.Builder
minCount(int value)
Required - Minimum number of snapshots to retain, even if the snapshots have expired.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
expireAfter
public final Retention.Builder expireAfter(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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
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
Required - Minimum number of snapshots to retain, even if the snapshots have expired.API name:
min_count
-
build
Builds aRetention
.- Specified by:
build
in interfaceObjectBuilder<Retention>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-