Package co.elastic.clients.elasticsearch.transform

Class Settings

java.lang.Object
co.elastic.clients.elasticsearch.transform.Settings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class Settings
extends java.lang.Object
implements JsonpSerializable
The source of the data for the transform.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static Settings of​(java.util.function.Function<Settings.Builder,​ObjectBuilder<Settings>> fn)

    • alignCheckpoints

      @Nullable public final java.lang.Boolean alignCheckpoints()
      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

      @Nullable public final java.lang.Boolean datesAsEpochMillis()
      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

    • docsPerSecond

      @Nullable public final java.lang.Float docsPerSecond()
      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

      @Nullable public final java.lang.Integer maxPageSearchSize()
      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

    • 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)

    • setupSettingsDeserializer

      protected static void setupSettingsDeserializer​(ObjectDeserializer<Settings.Builder> op)