Package co.elastic.clients.elasticsearch.transform

Class TimeRetentionPolicy.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<TimeRetentionPolicy.Builder>

co.elastic.clients.elasticsearch.transform.TimeRetentionPolicy.Builder

All Implemented Interfaces:

WithJson<TimeRetentionPolicy.Builder>, ObjectBuilder<TimeRetentionPolicy>

Enclosing class:

TimeRetentionPolicy

public static class TimeRetentionPolicy.Builder
extends WithJsonObjectBuilderBase<TimeRetentionPolicy.Builder>
implements ObjectBuilder<TimeRetentionPolicy>

Builder for TimeRetentionPolicy.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TimeRetentionPolicy	build()	Builds a TimeRetentionPolicy.
final TimeRetentionPolicy.Builder	field(String value)	Required - The date field that is used to calculate the age of the document.
final TimeRetentionPolicy.Builder	maxAge(Time value)	Required - Specifies the maximum age of a document in the destination index.
final TimeRetentionPolicy.Builder	maxAge(Function<Time.Builder,ObjectBuilder<Time>> fn)	Required - Specifies the maximum age of a document in the destination index.
protected TimeRetentionPolicy.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final TimeRetentionPolicy.Builder field(String value)

Required - The date field that is used to calculate the age of the document.

API name: field

maxAge

public final TimeRetentionPolicy.Builder maxAge(Time value)

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

maxAge

public final TimeRetentionPolicy.Builder maxAge(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

self

protected TimeRetentionPolicy.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<TimeRetentionPolicy.Builder>

build

public TimeRetentionPolicy build()

Builds a TimeRetentionPolicy.

Specified by:

build in interface ObjectBuilder<TimeRetentionPolicy>

Throws:

NullPointerException - if some of the required fields are null.