Package co.elastic.clients.elasticsearch.transform

Class Settings.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Settings.Builder>
co.elastic.clients.elasticsearch.transform.Settings.Builder
All Implemented Interfaces:
WithJson<Settings.Builder>, ObjectBuilder<Settings>
Enclosing class:
Settings
public static class Settings.Builder extends WithJsonObjectBuilderBase<Settings.Builder> implements ObjectBuilder<Settings>
Builder for Settings.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • alignCheckpoints

      public final Settings.Builder alignCheckpoints(@Nullable Boolean value)
      Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the transform config. As a result, less document updates in the destination index will be performed thus improving overall performance.

      API name: align_checkpoints

    • datesAsEpochMillis

      public final Settings.Builder datesAsEpochMillis(@Nullable Boolean value)
      Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was the default for transforms created before version 7.11. For compatible output set this value to true.

      API name: dates_as_epoch_millis

    • deduceMappings

      public final Settings.Builder deduceMappings(@Nullable Boolean value)
      Specifies whether the transform should deduce the destination index mappings from the transform configuration.

      API name: deduce_mappings

    • docsPerSecond

      public final Settings.Builder docsPerSecond(@Nullable Float value)
      Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.

      API name: docs_per_second

    • maxPageSearchSize

      public final Settings.Builder maxPageSearchSize(@Nullable Integer value)
      Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 65,536.

      API name: max_page_search_size

    • usePointInTime

      public final Settings.Builder usePointInTime(@Nullable Boolean value)
      Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index. In general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount of refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a given index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and the amount of other consumers searching the same source index.

      API name: use_point_in_time

    • unattended

      public final Settings.Builder unattended(@Nullable Boolean value)
      If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails. Setting the number of retries other than infinite fails in validation.

      API name: unattended

    • self

      protected Settings.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<Settings.Builder>

    • build

      public Settings build()
      Builds a Settings.
      Specified by:
      build in interface ObjectBuilder<Settings>
      Throws:
      NullPointerException - if some of the required fields are null.