Class Job.Builder
- All Implemented Interfaces:
WithJson<Job.Builder>
,ObjectBuilder<Job>
- Enclosing class:
- Job
Job
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Job.Builder
allowLazyOpen
(boolean value) Required - Advanced configuration option.final Job.Builder
analysisConfig
(AnalysisConfig value) Required - The analysis configuration, which specifies how to analyze the data.final Job.Builder
Required - The analysis configuration, which specifies how to analyze the data.final Job.Builder
analysisLimits
(AnalysisLimits value) Limits can be applied for the resources required to hold the mathematical models in memory.final Job.Builder
Limits can be applied for the resources required to hold the mathematical models in memory.final Job.Builder
backgroundPersistInterval
(Time value) Advanced configuration option.final Job.Builder
Advanced configuration option.final Job.Builder
blocked
(JobBlocked value) API name:blocked
final Job.Builder
API name:blocked
build()
Builds aJob
.final Job.Builder
createTime
(DateTime value) API name:create_time
final Job.Builder
customSettings
(JsonData value) Advanced configuration option.final Job.Builder
Advanced configuration option, which affects the automatic removal of old model snapshots for this job.final Job.Builder
dataDescription
(DataDescription value) Required - The data description defines the format of the input data when you send data to the job by using the post data API.final Job.Builder
Required - The data description defines the format of the input data when you send data to the job by using the post data API.final Job.Builder
datafeedConfig
(Datafeed value) The datafeed, which retrieves data from Elasticsearch for analysis by the job.final Job.Builder
The datafeed, which retrieves data from Elasticsearch for analysis by the job.final Job.Builder
Indicates that the process of deleting the job is in progress but not yet completed.final Job.Builder
description
(String value) A description of the job.final Job.Builder
finishedTime
(DateTime value) If the job closed or failed, this is the time the job finished, otherwise it isnull
.final Job.Builder
A list of job groups.final Job.Builder
A list of job groups.final Job.Builder
Required - Identifier for the anomaly detection job.final Job.Builder
Reserved for future use, currently set toanomaly_detector
.final Job.Builder
jobVersion
(String value) The machine learning configuration version number at which the the job was created.final Job.Builder
modelPlotConfig
(ModelPlotConfig value) This advanced configuration option stores model information along with the results.final Job.Builder
This advanced configuration option stores model information along with the results.final Job.Builder
modelSnapshotId
(String value) API name:model_snapshot_id
final Job.Builder
modelSnapshotRetentionDays
(long value) Required - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.final Job.Builder
renormalizationWindowDays
(Long value) Advanced configuration option.final Job.Builder
resultsIndexName
(String value) Required - A text string that affects the name of the machine learning results index.final Job.Builder
resultsRetentionDays
(Long value) Advanced configuration option.protected Job.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowLazyOpen
Required - 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.API name:
allow_lazy_open
-
analysisConfig
Required - The analysis configuration, which specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.API name:
analysis_config
-
analysisConfig
public final Job.Builder analysisConfig(Function<AnalysisConfig.Builder, ObjectBuilder<AnalysisConfig>> fn) Required - The analysis configuration, which specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.API name:
analysis_config
-
analysisLimits
Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.API name:
analysis_limits
-
analysisLimits
public final Job.Builder analysisLimits(Function<AnalysisLimits.Builder, ObjectBuilder<AnalysisLimits>> fn) Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.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.API name:
background_persist_interval
-
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.API name:
background_persist_interval
-
blocked
API name:blocked
-
blocked
API name:blocked
-
createTime
API name:create_time
-
customSettings
Advanced configuration option. Contains custom metadata about the job.API name:
custom_settings
-
dailyModelSnapshotRetentionAfterDays
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
.API name:
daily_model_snapshot_retention_after_days
-
dataDescription
Required - The data description defines the format of the input data when you send data to the job by using the post data API. Note that when configuring a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.API name:
data_description
-
dataDescription
public final Job.Builder dataDescription(Function<DataDescription.Builder, ObjectBuilder<DataDescription>> fn) Required - The data description defines the format of the input data when you send data to the job by using the post data API. Note that when configuring a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.API name:
data_description
-
datafeedConfig
The datafeed, which retrieves data from Elasticsearch for analysis by the job. You can associate only one datafeed with each anomaly detection job.API name:
datafeed_config
-
datafeedConfig
The datafeed, which retrieves data from Elasticsearch for analysis by the job. You can associate only one datafeed with each anomaly detection job.API name:
datafeed_config
-
deleting
Indicates that the process of deleting the job is in progress but not yet completed. It is only reported whentrue
.API name:
deleting
-
description
A description of the job.API name:
description
-
finishedTime
If the job closed or failed, this is the time the job finished, otherwise it isnull
. This property is informational; you cannot change its value.API name:
finished_time
-
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 anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.API name:
job_id
-
jobType
Reserved for future use, currently set toanomaly_detector
.API name:
job_type
-
jobVersion
The machine learning configuration version number at which the the job was created.API name:
job_version
-
modelPlotConfig
This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. Model plot provides a simplified and indicative view of the model and its bounds.API name:
model_plot_config
-
modelPlotConfig
public final Job.Builder modelPlotConfig(Function<ModelPlotConfig.Builder, ObjectBuilder<ModelPlotConfig>> fn) This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. Model plot provides a simplified and indicative view of the model and its bounds.API name:
model_plot_config
-
modelSnapshotId
API name:model_snapshot_id
-
modelSnapshotRetentionDays
Required - 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. By default, snapshots ten days older than the newest snapshot are deleted.API name:
model_snapshot_retention_days
-
renormalizationWindowDays
Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100bucket_spans
.API name:
renormalization_window_days
-
resultsIndexName
Required - A text string that affects the name of the machine learning results index. The default value isshared
, which generates an index named.ml-anomalies-shared
.API name:
results_index_name
-
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. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.API name:
results_retention_days
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<Job.Builder>
-
build
Builds aJob
.- Specified by:
build
in interfaceObjectBuilder<Job>
- Throws:
NullPointerException
- if some of the required fields are null.
-