Class Settings
java.lang.Object
co.elastic.clients.elasticsearch.transform.Settings
- All Implemented Interfaces:
JsonpSerializable
The source of the data for the transform.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<Settings>
Json deserializer forSettings
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies whether the transform checkpoint ranges should be optimized for performance.final Boolean
Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch.final Boolean
Specifies whether the transform should deduce the destination index mappings from the transform configuration.final Float
Specifies a limit on the number of input documents per second.final Integer
Defines the initial page size to use for the composite aggregation for each checkpoint.static Settings
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
toString()
final Boolean
Iftrue
, the transform runs in unattended mode.
-
Field Details
-
_DESERIALIZER
Json deserializer forSettings
-
-
Method Details
-
of
-
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
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 totrue
.API name:
dates_as_epoch_millis
-
deduceMappings
Specifies whether the transform should deduce the destination index mappings from the transform configuration.API name:
deduce_mappings
-
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
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 is10
and the maximum is65,536
.API name:
max_page_search_size
-
unattended
Iftrue
, 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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupSettingsDeserializer
-