Package co.elastic.clients.elasticsearch.transform

Class Settings.Builder

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

  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    Settings build()
    Builds a Settings.
    Settings.Builder datesAsEpochMillis​(java.lang.Boolean value)
    Defines if dates in the ouput should be written as ISO formatted string (default) or as millis since epoch.
    Settings.Builder docsPerSecond​(java.lang.Float value)
    Specifies a limit on the number of input documents per second.
    Settings.Builder maxPageSearchSize​(java.lang.Integer value)
    Defines the initial page size to use for the composite aggregation for each checkpoint.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • datesAsEpochMillis

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

      API name: dates_as_epoch_millis

    • docsPerSecond

      public Settings.Builder docsPerSecond​(@Nullable java.lang.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 Settings.Builder maxPageSearchSize​(@Nullable java.lang.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 10,000.

      API name: max_page_search_size

    • build

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