Class SettingsConfig.Builder
java.lang.Object
org.elasticsearch.client.transform.transforms.SettingsConfig.Builder
- Enclosing class:
- SettingsConfig
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
setAlignCheckpoints
(Boolean alignCheckpoints) Whether to align transform checkpoint ranges with date histogram interval.setDatesAsEpochMillis
(Boolean datesAsEpochMillis) Whether to write the output of a date aggregation as millis since epoch or as formatted string (ISO format).setMaxPageSearchSize
(Integer maxPageSearchSize) Sets the paging maximum paging maxPageSearchSize that transform can use when pulling the data from the source index.setRequestsPerSecond
(Float documentsPerSecond) Sets the docs per second that transform can use when pulling the data from the source index.Whether the point in time API should be used for search.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
setMaxPageSearchSize
Sets the paging maximum paging maxPageSearchSize that transform can use when pulling the data from the source index. If OOM is triggered, the paging maxPageSearchSize is dynamically reduced so that the transform can continue to gather data.- Parameters:
maxPageSearchSize
- Integer value between 10 and 10_000- Returns:
- the
SettingsConfig.Builder
with the paging maxPageSearchSize set.
-
setRequestsPerSecond
Sets the docs per second that transform can use when pulling the data from the source index. This setting throttles transform by issuing queries less often, however processing still happens in batches. A value of 0 disables throttling (default).- Parameters:
documentsPerSecond
- Integer value- Returns:
- the
SettingsConfig.Builder
with requestsPerSecond set.
-
setDatesAsEpochMillis
Whether to write the output of a date aggregation as millis since epoch or as formatted string (ISO format). Transforms created before 7.11 write dates as epoch_millis. The new default is ISO string. You can use this setter to configure the old style writing as epoch millis. An explicit `null` resets to default.- Parameters:
datesAsEpochMillis
- true if dates should be written as epoch_millis.- Returns:
- the
SettingsConfig.Builder
with datesAsEpochMilli set.
-
setAlignCheckpoints
Whether to align transform checkpoint ranges with date histogram interval. An explicit `null` resets to default.- Parameters:
alignCheckpoints
- true if checkpoint ranges should be aligned with date histogram interval.- Returns:
- the
SettingsConfig.Builder
with alignCheckpoints set.
-
setUsePit
Whether the point in time API should be used for search. Point in time is a more resource friendly way to query. It is used by default. In case of problems you can disable the point in time API usage with this setting. An explicit `null` resets to default.- Parameters:
usePit
- true if the point in time API should be used.- Returns:
- the
SettingsConfig.Builder
with usePit set.
-
build
-