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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPutDataLifecycleRequest
.dataRetention
(Time value) If defined, every document added to this data stream will be stored at least for this time frame.If defined, every document added to this data stream will be stored at least for this time frame.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of data stream that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of data stream that wildcard patterns can match.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.Required - Comma-separated list of data streams used to limit the request.Required - Comma-separated list of data streams used to limit the request.protected PutDataLifecycleRequest.Builder
self()
Period to wait for a response.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
dataRetention
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
-
expandWildcards
Type of data stream that wildcard patterns can match. Supports comma-separated values, such asopen,hidden
. Valid values are:all
,hidden
,open
,closed
,none
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final PutDataLifecycleRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Type of data stream that wildcard patterns can match. Supports comma-separated values, such asopen,hidden
. Valid values are:all
,hidden
,open
,closed
,none
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
masterTimeout
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
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
toname
. -
name
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
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
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
- Specified by:
self
in classRequestBase.AbstractBuilder<PutDataLifecycleRequest.Builder>
-
build
Builds aPutDataLifecycleRequest
.- Specified by:
build
in interfaceObjectBuilder<PutDataLifecycleRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-