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:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Settings.Builder	Builder for Settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Settings>	_DESERIALIZER	Json deserializer for Settings

Method Summary

Modifier and Type	Method	Description
final Boolean	alignCheckpoints()	Specifies whether the transform checkpoint ranges should be optimized for performance.
final Boolean	datesAsEpochMillis()	Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch.
final Float	docsPerSecond()	Specifies a limit on the number of input documents per second.
final Integer	maxPageSearchSize()	Defines the initial page size to use for the composite aggregation for each checkpoint.
static Settings	of(Function<Settings.Builder,ObjectBuilder<Settings>> fn)
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	setupSettingsDeserializer(ObjectDeserializer<Settings.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Settings> _DESERIALIZER

Json deserializer for Settings

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

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

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)