Package co.elastic.clients.elasticsearch.indices

Class DataStreamLifecycle.AbstractBuilder<BuilderT extends DataStreamLifecycle.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.indices.DataStreamLifecycle.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
DataStreamLifecycle.Builder, DataStreamLifecycleWithRollover.Builder
Enclosing class:
DataStreamLifecycle
public abstract static class DataStreamLifecycle.AbstractBuilder<BuilderT extends DataStreamLifecycle.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • dataRetention

      public final BuilderT 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 BuilderT 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

    • effectiveRetention

      public final BuilderT effectiveRetention(@Nullable Time value)
      The least amount of time data should be kept by elasticsearch.

      API name: effective_retention

    • effectiveRetention

      public final BuilderT effectiveRetention(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The least amount of time data should be kept by elasticsearch.

      API name: effective_retention

    • retentionDeterminedBy

      public final BuilderT retentionDeterminedBy(@Nullable RetentionSource value)
      Configuration source that can influence the retention of a data stream.

      API name: retention_determined_by

    • downsampling

      public final BuilderT downsampling(List<DownsamplingRound> list)
      The list of downsampling rounds to execute as part of this downsampling configuration

      API name: downsampling

      Adds all elements of list to downsampling.

    • downsampling

      public final BuilderT downsampling(DownsamplingRound value, DownsamplingRound... values)
      The list of downsampling rounds to execute as part of this downsampling configuration

      API name: downsampling

      Adds one or more values to downsampling.

    • downsampling

      public final BuilderT downsampling(Function<DownsamplingRound.Builder,ObjectBuilder<DownsamplingRound>> fn)
      The list of downsampling rounds to execute as part of this downsampling configuration

      API name: downsampling

      Adds a value to downsampling using a builder lambda.

    • downsamplingMethod

      public final BuilderT downsamplingMethod(@Nullable SamplingMethod value)
      The method used to downsample the data. There are two options aggregate and last_value. It requires downsampling to be defined. Defaults to aggregate.

      API name: downsampling_method

    • enabled

      public final BuilderT 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

    • frozenAfter

      public final BuilderT frozenAfter(@Nullable Time value)
      The period after which data stream backing indices are automatically converted to partially mounted searchable snapshots. This field is valid only on main data stream lifecycles and cannot be set on failure-store lifecycles.

      API name: frozen_after

    • frozenAfter

      public final BuilderT frozenAfter(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period after which data stream backing indices are automatically converted to partially mounted searchable snapshots. This field is valid only on main data stream lifecycles and cannot be set on failure-store lifecycles.

      API name: frozen_after

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends DataStreamLifecycle.AbstractBuilder<BuilderT>>