Class TimeRetentionPolicy
java.lang.Object
co.elastic.clients.elasticsearch.transform.TimeRetentionPolicy
- All Implemented Interfaces:
RetentionPolicyVariant
,JsonpSerializable
@JsonpDeserializable
public class TimeRetentionPolicy
extends Object
implements RetentionPolicyVariant, JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<TimeRetentionPolicy>
Json deserializer forTimeRetentionPolicy
-
Method Summary
Modifier and TypeMethodDescriptionRetentionPolicy variant kind.final String
field()
Required - The date field that is used to calculate the age of the document.final Time
maxAge()
Required - Specifies the maximum age of a document in the destination index.static TimeRetentionPolicy
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()
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(Function<TimeRetentionPolicy.Builder, ObjectBuilder<TimeRetentionPolicy>> fn) -
_retentionPolicyKind
RetentionPolicy variant kind.- Specified by:
_retentionPolicyKind
in interfaceRetentionPolicyVariant
-
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
-
setupTimeRetentionPolicyDeserializer
protected static void setupTimeRetentionPolicyDeserializer(ObjectDeserializer<TimeRetentionPolicy.Builder> op)
-