Class PutDataLifecycleRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutDataLifecycleRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutDataLifecycleRequest
extends RequestBase
implements JsonpSerializable
Update the data lifecycle of the specified data streams.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutDataLifecycleRequest>
Json deserializer forPutDataLifecycleRequest
static final Endpoint<PutDataLifecycleRequest,
PutDataLifecycleResponse, ErrorResponse> Endpoint "indices.put_data_lifecycle
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Time
If defined, every document added to this data stream will be stored at least for this time frame.If defined, every backing index will execute the configured downsampling configuration after the backing index is not the data stream write index anymore.final List<ExpandWildcard>
Type of data stream that wildcard patterns can match.final Time
Period to wait for a connection to the master node.name()
Required - Comma-separated list of data streams used to limit the request.static PutDataLifecycleRequest
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
final Time
timeout()
Period to wait for a response.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forPutDataLifecycleRequest
-
_ENDPOINT
public static final Endpoint<PutDataLifecycleRequest,PutDataLifecycleResponse, _ENDPOINTErrorResponse> Endpoint "indices.put_data_lifecycle
".
-
-
Method Details
-
of
public static PutDataLifecycleRequest of(Function<PutDataLifecycleRequest.Builder, ObjectBuilder<PutDataLifecycleRequest>> fn) -
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
-
downsampling
If defined, every backing index will execute the configured downsampling configuration after the backing index is not the data stream write index anymore.API name:
downsampling
-
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
-
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
-
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
-
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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutDataLifecycleRequestDeserializer
protected static void setupPutDataLifecycleRequestDeserializer(ObjectDeserializer<PutDataLifecycleRequest.Builder> op)
-