TimeRetentionPolicy (java-client 7.16.3 API)

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 for TimeRetentionPolicy.
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<TimeRetentionPolicy> _DESERIALIZER
Json deserializer for TimeRetentionPolicy

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)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch.transform.RetentionPolicyVariant

_toRetentionPolicy

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<TimeRetentionPolicy> _DESERIALIZER
  
  Json deserializer for TimeRetentionPolicy
Method Details
- of
  
  public static TimeRetentionPolicy of(java.util.function.Function<TimeRetentionPolicy.Builder,ObjectBuilder<TimeRetentionPolicy>> fn)
- _retentionPolicyKind
  
  public RetentionPolicy.Kind _retentionPolicyKind()
  
  RetentionPolicy variant kind.
  
  Specified by:
  
  _retentionPolicyKind in interface RetentionPolicyVariant
- 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
  
  public final Time 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
  
  public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Serialize this object to JSON.
  
  Specified by:
  
  serialize in interface JsonpSerializable
- serializeInternal
  
  protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
- setupTimeRetentionPolicyDeserializer
  
  protected static void setupTimeRetentionPolicyDeserializer(ObjectDeserializer<TimeRetentionPolicy.Builder> op)