Package co.elastic.clients.elasticsearch.indices

Class PutDataLifecycleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutDataLifecycleRequest.Builder>

co.elastic.clients.elasticsearch.indices.PutDataLifecycleRequest.Builder

All Implemented Interfaces:

WithJson<PutDataLifecycleRequest.Builder>, ObjectBuilder<PutDataLifecycleRequest>

Enclosing class:

PutDataLifecycleRequest

public static class PutDataLifecycleRequest.Builder
extends RequestBase.AbstractBuilder<PutDataLifecycleRequest.Builder>
implements ObjectBuilder<PutDataLifecycleRequest>

Builder for PutDataLifecycleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutDataLifecycleRequest	build()	Builds a PutDataLifecycleRequest.
final PutDataLifecycleRequest.Builder	dataRetention(Time value)	If defined, every document added to this data stream will be stored at least for this time frame.
final PutDataLifecycleRequest.Builder	dataRetention(Function<Time.Builder,ObjectBuilder<Time>> fn)	If defined, every document added to this data stream will be stored at least for this time frame.
final PutDataLifecycleRequest.Builder	downsampling(DataStreamLifecycleDownsampling value)	The downsampling configuration to execute for the managed backing index after rollover.
final PutDataLifecycleRequest.Builder	downsampling(Function<DataStreamLifecycleDownsampling.Builder,ObjectBuilder<DataStreamLifecycleDownsampling>> fn)	The downsampling configuration to execute for the managed backing index after rollover.
final PutDataLifecycleRequest.Builder	enabled(Boolean value)	If defined, it turns data stream lifecycle on/off (true/false) for this data stream.
final PutDataLifecycleRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of data stream that wildcard patterns can match.
final PutDataLifecycleRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of data stream that wildcard patterns can match.
final PutDataLifecycleRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final PutDataLifecycleRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final PutDataLifecycleRequest.Builder	name(String value, String... values)	Required - Comma-separated list of data streams used to limit the request.
final PutDataLifecycleRequest.Builder	name(List<String> list)	Required - Comma-separated list of data streams used to limit the request.
protected PutDataLifecycleRequest.Builder	self()
final PutDataLifecycleRequest.Builder	timeout(Time value)	Period to wait for a response.
final PutDataLifecycleRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.

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

dataRetention

public final PutDataLifecycleRequest.Builder dataRetention(@Nullable
 Time value)

If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.

API name: data_retention

dataRetention

public final PutDataLifecycleRequest.Builder dataRetention(Function<Time.Builder,ObjectBuilder<Time>> fn)

If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.

API name: data_retention

downsampling

public final PutDataLifecycleRequest.Builder downsampling(@Nullable
 DataStreamLifecycleDownsampling value)

The downsampling configuration to execute for the managed backing index after rollover.

API name: downsampling

downsampling

public final PutDataLifecycleRequest.Builder downsampling(Function<DataStreamLifecycleDownsampling.Builder,ObjectBuilder<DataStreamLifecycleDownsampling>> fn)

The downsampling configuration to execute for the managed backing index after rollover.

API name: downsampling

enabled

public final PutDataLifecycleRequest.Builder enabled(@Nullable
 Boolean value)

If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.

API name: enabled

expandWildcards

public final PutDataLifecycleRequest.Builder expandWildcards(List<ExpandWildcard> list)

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final PutDataLifecycleRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds one or more values to expandWildcards.

masterTimeout

public final PutDataLifecycleRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

public final PutDataLifecycleRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

name

public final PutDataLifecycleRequest.Builder name(List<String> list)

Required - Comma-separated list of data streams used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

API name: name

Adds all elements of list to name.

name

public final PutDataLifecycleRequest.Builder name(String value,
 String... values)

Required - Comma-separated list of data streams used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

API name: name

Adds one or more values to name.

timeout

public final PutDataLifecycleRequest.Builder timeout(@Nullable
 Time value)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

public final PutDataLifecycleRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

self

protected PutDataLifecycleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutDataLifecycleRequest.Builder>

build

public PutDataLifecycleRequest build()

Builds a PutDataLifecycleRequest.

Specified by:

build in interface ObjectBuilder<PutDataLifecycleRequest>

Throws:

NullPointerException - if some of the required fields are null.