Package co.elastic.clients.elasticsearch.indices

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 data stream lifecycles. Update the data stream lifecycle of the specified data streams.
See Also:

  • Field Details

  • Method Details

    • of

      public static PutDataLifecycleRequest of(Function<PutDataLifecycleRequest.Builder,ObjectBuilder<PutDataLifecycleRequest>> fn)

    • dataRetention

      @Nullable public final Time 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

      @Nullable public final DataStreamLifecycleDownsampling downsampling()
      The downsampling configuration to execute for the managed backing index after rollover.

      API name: downsampling

    • enabled

      @Nullable public final Boolean enabled()
      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 List<ExpandWildcard> expandWildcards()
      Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden. Valid values are: all, hidden, open, closed, none.

      API name: expand_wildcards

    • masterTimeout

      @Nullable public final Time 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

      public final List<String> 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

      @Nullable public final Time 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

      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)

    • setupPutDataLifecycleRequestDeserializer

      protected static void setupPutDataLifecycleRequestDeserializer(ObjectDeserializer<PutDataLifecycleRequest.Builder> op)