Class Settings.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Settings.Builder>
co.elastic.clients.elasticsearch.transform.Settings.Builder
- All Implemented Interfaces:
WithJson<Settings.Builder>
,ObjectBuilder<Settings>
- Enclosing class:
- Settings
public static class Settings.Builder extends WithJsonObjectBuilderBase<Settings.Builder> implements ObjectBuilder<Settings>
Builder for
Settings
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description Settings.Builder
alignCheckpoints(java.lang.Boolean value)
Specifies whether the transform checkpoint ranges should be optimized for performance.Settings
build()
Builds aSettings
.Settings.Builder
datesAsEpochMillis(java.lang.Boolean value)
Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch.Settings.Builder
deduceMappings(java.lang.Boolean value)
Specifies whether the transform should deduce the destination index mappings from the transform configuration.Settings.Builder
docsPerSecond(java.lang.Float value)
Specifies a limit on the number of input documents per second.Settings.Builder
maxPageSearchSize(java.lang.Integer value)
Defines the initial page size to use for the composite aggregation for each checkpoint.protected Settings.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<Settings.Builder>
-
build
Builds aSettings
.- Specified by:
build
in interfaceObjectBuilder<Settings>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-