TimeRetentionPolicy (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch.transform.TimeRetentionPolicy

All Implemented Interfaces:: RetentionPolicyVariant, JsonpSerializable, UnionVariant

@JsonpDeserializable
public final class TimeRetentionPolicy
extends java.lang.Object
implements RetentionPolicyVariant, JsonpSerializable

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

Constructor Summary

Constructors
Constructor	Description
`TimeRetentionPolicy(TimeRetentionPolicy.Builder builder)`
`TimeRetentionPolicy(java.util.function.Function<TimeRetentionPolicy.Builder,TimeRetentionPolicy.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`_variantType()`	`RetentionPolicy` variant type
`java.lang.String`	`field()`	Required - The date field that is used to calculate the age of the document.
`java.lang.String`	`maxAge()`	Required - Specifies the maximum age of a document in the destination index.
`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(DelegatingDeserializer<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
Constructor Details
- TimeRetentionPolicy
  
  public TimeRetentionPolicy(TimeRetentionPolicy.Builder builder)
- TimeRetentionPolicy
  
  public TimeRetentionPolicy(java.util.function.Function<TimeRetentionPolicy.Builder,TimeRetentionPolicy.Builder> fn)
Method Details
- _variantType
  
  public java.lang.String _variantType()
  
  RetentionPolicy variant type
  
  Specified by:
  
  _variantType in interface UnionVariant
- field
  
  public java.lang.String field()
  
  Required - The date field that is used to calculate the age of the document.
  API name: field
- maxAge
  
  public java.lang.String 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(DelegatingDeserializer<TimeRetentionPolicy.Builder> op)