Package co.elastic.clients.elasticsearch.transform

Class Settings

java.lang.Object

co.elastic.clients.elasticsearch.transform.Settings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public final class Settings
extends java.lang.Object
implements JsonpSerializable

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 JsonpDeserializer<Settings>	_DESERIALIZER	Json deserializer for Settings

Constructor Summary

Constructors

Constructor	Description
Settings(Settings.Builder builder)
Settings(java.util.function.Function<Settings.Builder,Settings.Builder> fn)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Settings> _DESERIALIZER

Json deserializer for Settings

Constructor Details

Settings

public Settings(Settings.Builder builder)

Settings

public Settings(java.util.function.Function<Settings.Builder,Settings.Builder> fn)

Method Details

datesAsEpochMillis

@Nullable
public java.lang.Boolean datesAsEpochMillis()

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

@Nullable
public 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 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 10,000.

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(DelegatingDeserializer<Settings.Builder> op)