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 Object implements JsonpSerializable
The source of the data for the transform.
See Also:

  • Field Details

  • Method Details

    • of

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

    • alignCheckpoints

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

    • deduceMappings

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

      API name: deduce_mappings

    • docsPerSecond

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

    • usePointInTime

      @Nullable public final Boolean usePointInTime()
      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

      @Nullable public final Boolean unattended()
      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

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupSettingsDeserializer

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