Class UpdateJobRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<UpdateJobRequest>
- Enclosing class:
- UpdateJobRequest
public static class UpdateJobRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<UpdateJobRequest>
UpdateJobRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description UpdateJobRequest.Builder
allowLazyOpen(java.lang.Boolean value)
Advanced configuration option.UpdateJobRequest.Builder
analysisLimits(AnalysisMemoryLimit value)
API name:analysis_limits
UpdateJobRequest.Builder
analysisLimits(java.util.function.Function<AnalysisMemoryLimit.Builder,ObjectBuilder<AnalysisMemoryLimit>> fn)
API name:analysis_limits
UpdateJobRequest.Builder
backgroundPersistInterval(Time value)
Advanced configuration option.UpdateJobRequest.Builder
backgroundPersistInterval(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Advanced configuration option.UpdateJobRequest
build()
Builds aUpdateJobRequest
.UpdateJobRequest.Builder
categorizationFilters(java.lang.String value, java.lang.String... values)
API name:categorization_filters
UpdateJobRequest.Builder
categorizationFilters(java.util.List<java.lang.String> list)
API name:categorization_filters
UpdateJobRequest.Builder
customSettings(java.lang.String key, JsonData value)
Advanced configuration option.UpdateJobRequest.Builder
customSettings(java.util.Map<java.lang.String,JsonData> map)
Advanced configuration option.UpdateJobRequest.Builder
dailyModelSnapshotRetentionAfterDays(java.lang.Long value)
Advanced configuration option, which affects the automatic removal of old model snapshots for this job.UpdateJobRequest.Builder
description(java.lang.String value)
A description of the job.UpdateJobRequest.Builder
detectors(Detector value, Detector... values)
An array of detector update objects.UpdateJobRequest.Builder
detectors(java.util.function.Function<Detector.Builder,ObjectBuilder<Detector>> fn)
An array of detector update objects.UpdateJobRequest.Builder
detectors(java.util.List<Detector> list)
An array of detector update objects.UpdateJobRequest.Builder
groups(java.lang.String value, java.lang.String... values)
A list of job groups.UpdateJobRequest.Builder
groups(java.util.List<java.lang.String> list)
A list of job groups.UpdateJobRequest.Builder
jobId(java.lang.String value)
Required - Identifier for the job.UpdateJobRequest.Builder
modelPlotConfig(ModelPlotConfig value)
API name:model_plot_config
UpdateJobRequest.Builder
modelPlotConfig(java.util.function.Function<ModelPlotConfig.Builder,ObjectBuilder<ModelPlotConfig>> fn)
API name:model_plot_config
UpdateJobRequest.Builder
modelSnapshotRetentionDays(java.lang.Long value)
Advanced configuration option, which affects the automatic removal of old model snapshots for this job.UpdateJobRequest.Builder
perPartitionCategorization(PerPartitionCategorization value)
Settings related to how categorization interacts with partition fields.UpdateJobRequest.Builder
perPartitionCategorization(java.util.function.Function<PerPartitionCategorization.Builder,ObjectBuilder<PerPartitionCategorization>> fn)
Settings related to how categorization interacts with partition fields.UpdateJobRequest.Builder
renormalizationWindowDays(java.lang.Long value)
Advanced configuration option.UpdateJobRequest.Builder
resultsRetentionDays(java.lang.Long value)
Advanced configuration option.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
-
allowLazyOpen
Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. Iffalse
and a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-widexpack.ml.max_lazy_ml_nodes
setting. If this option is set totrue
, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.API name:
allow_lazy_open
-
analysisLimits
API name:analysis_limits
-
analysisLimits
public final UpdateJobRequest.Builder analysisLimits(java.util.function.Function<AnalysisMemoryLimit.Builder,ObjectBuilder<AnalysisMemoryLimit>> fn)API name:analysis_limits
-
backgroundPersistInterval
Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low. If the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect.API name:
background_persist_interval
-
backgroundPersistInterval
public final UpdateJobRequest.Builder backgroundPersistInterval(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low. If the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect.API name:
background_persist_interval
-
categorizationFilters
API name:categorization_filters
Adds all elements of
list
tocategorizationFilters
. -
categorizationFilters
public final UpdateJobRequest.Builder categorizationFilters(java.lang.String value, java.lang.String... values)API name:categorization_filters
Adds one or more values to
categorizationFilters
. -
customSettings
public final UpdateJobRequest.Builder customSettings(java.util.Map<java.lang.String,JsonData> map)Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results.API name:
custom_settings
Adds all entries of
map
tocustomSettings
. -
customSettings
Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results.API name:
custom_settings
Adds an entry to
customSettings
. -
dailyModelSnapshotRetentionAfterDays
public final UpdateJobRequest.Builder dailyModelSnapshotRetentionAfterDays(@Nullable java.lang.Long value)Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 tomodel_snapshot_retention_days
. For jobs created before version 7.8.0, the default value matchesmodel_snapshot_retention_days
.API name:
daily_model_snapshot_retention_after_days
-
description
A description of the job.API name:
description
-
detectors
An array of detector update objects.API name:
detectors
Adds all elements of
list
todetectors
. -
detectors
An array of detector update objects.API name:
detectors
Adds one or more values to
detectors
. -
detectors
public final UpdateJobRequest.Builder detectors(java.util.function.Function<Detector.Builder,ObjectBuilder<Detector>> fn)An array of detector update objects.API name:
detectors
Adds a value to
detectors
using a builder lambda. -
groups
A list of job groups. A job can belong to no groups or many.API name:
groups
Adds all elements of
list
togroups
. -
groups
A list of job groups. A job can belong to no groups or many.API name:
groups
Adds one or more values to
groups
. -
jobId
Required - Identifier for the job.API name:
job_id
-
modelPlotConfig
API name:model_plot_config
-
modelPlotConfig
public final UpdateJobRequest.Builder modelPlotConfig(java.util.function.Function<ModelPlotConfig.Builder,ObjectBuilder<ModelPlotConfig>> fn)API name:model_plot_config
-
modelSnapshotRetentionDays
Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job.API name:
model_snapshot_retention_days
-
perPartitionCategorization
public final UpdateJobRequest.Builder perPartitionCategorization(@Nullable PerPartitionCategorization value)Settings related to how categorization interacts with partition fields.API name:
per_partition_categorization
-
perPartitionCategorization
public final UpdateJobRequest.Builder perPartitionCategorization(java.util.function.Function<PerPartitionCategorization.Builder,ObjectBuilder<PerPartitionCategorization>> fn)Settings related to how categorization interacts with partition fields.API name:
per_partition_categorization
-
renormalizationWindowDays
Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.API name:
renormalization_window_days
-
resultsRetentionDays
Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained.API name:
results_retention_days
-
build
Builds aUpdateJobRequest
.- Specified by:
build
in interfaceObjectBuilder<UpdateJobRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-