Class TimeRetentionPolicy
java.lang.Object
co.elastic.clients.elasticsearch.transform.TimeRetentionPolicy
- All Implemented Interfaces:
RetentionPolicyVariant
,JsonpSerializable
@JsonpDeserializable public class TimeRetentionPolicy extends java.lang.Object implements RetentionPolicyVariant, JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TimeRetentionPolicy.Builder
Builder forTimeRetentionPolicy
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<TimeRetentionPolicy>
_DESERIALIZER
Json deserializer forTimeRetentionPolicy
-
Method Summary
Modifier and Type Method Description RetentionPolicy.Kind
_retentionPolicyKind()
RetentionPolicy variant kind.java.lang.String
field()
Required - The date field that is used to calculate the age of the document.Time
maxAge()
Required - Specifies the maximum age of a document in the destination index.static TimeRetentionPolicy
of(java.util.function.Function<TimeRetentionPolicy.Builder,ObjectBuilder<TimeRetentionPolicy>> fn)
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
setupTimeRetentionPolicyDeserializer(ObjectDeserializer<TimeRetentionPolicy.Builder> op)
java.lang.String
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch.transform.RetentionPolicyVariant
_toRetentionPolicy
-
Field Details
-
_DESERIALIZER
Json deserializer forTimeRetentionPolicy
-
-
Method Details
-
of
public static TimeRetentionPolicy of(java.util.function.Function<TimeRetentionPolicy.Builder,ObjectBuilder<TimeRetentionPolicy>> fn) -
_retentionPolicyKind
RetentionPolicy variant kind.- Specified by:
_retentionPolicyKind
in interfaceRetentionPolicyVariant
-
field
public final java.lang.String field()Required - The date field that is used to calculate the age of the document.API name:
field
-
maxAge
Required - Specifies the maximum age of a document in the destination index. Documents that are older than the configured value are removed from the destination index.API name:
max_age
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupTimeRetentionPolicyDeserializer
protected static void setupTimeRetentionPolicyDeserializer(ObjectDeserializer<TimeRetentionPolicy.Builder> op)
-