Class UpdateJobRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.UpdateJobRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class UpdateJobRequest extends RequestBase implements JsonpSerializable
Updates certain properties of an anomaly detection job.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UpdateJobRequest.Builder
Builder forUpdateJobRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<UpdateJobRequest>
_DESERIALIZER
Json deserializer forUpdateJobRequest
static Endpoint<UpdateJobRequest,UpdateJobResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.update_job
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowLazyOpen()
Advanced configuration option.AnalysisMemoryLimit
analysisLimits()
API name:analysis_limits
Time
backgroundPersistInterval()
Advanced configuration option.java.util.List<java.lang.String>
categorizationFilters()
API name:categorization_filters
java.util.Map<java.lang.String,JsonData>
customSettings()
Advanced configuration option.java.lang.Long
dailyModelSnapshotRetentionAfterDays()
Advanced configuration option, which affects the automatic removal of old model snapshots for this job.java.lang.String
description()
A description of the job.java.util.List<Detector>
detectors()
An array of detector update objects.java.util.List<java.lang.String>
groups()
A list of job groups.java.lang.String
jobId()
Required - Identifier for the job.ModelPlotConfig
modelPlotConfig()
API name:model_plot_config
java.lang.Long
modelSnapshotRetentionDays()
Advanced configuration option, which affects the automatic removal of old model snapshots for this job.static UpdateJobRequest
of(java.util.function.Function<UpdateJobRequest.Builder,ObjectBuilder<UpdateJobRequest>> fn)
PerPartitionCategorization
perPartitionCategorization()
Settings related to how categorization interacts with partition fields.java.lang.Long
renormalizationWindowDays()
Advanced configuration option.java.lang.Long
resultsRetentionDays()
Advanced configuration option.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
setupUpdateJobRequestDeserializer(ObjectDeserializer<UpdateJobRequest.Builder> op)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forUpdateJobRequest
-
_ENDPOINT
Endpoint "ml.update_job
".
-
-
Method Details
-
of
public static UpdateJobRequest of(java.util.function.Function<UpdateJobRequest.Builder,ObjectBuilder<UpdateJobRequest>> fn) -
allowLazyOpen
@Nullable public final java.lang.Boolean 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
-
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
-
categorizationFilters
public final java.util.List<java.lang.String> categorizationFilters()API name:categorization_filters
-
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
-
dailyModelSnapshotRetentionAfterDays
@Nullable public final java.lang.Long 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
. For jobs created before version 7.8.0, the default value matchesmodel_snapshot_retention_days
.API name:
daily_model_snapshot_retention_after_days
-
description
@Nullable public final java.lang.String description()A description of the job.API name:
description
-
detectors
An array of detector update objects.API name:
detectors
-
groups
public final java.util.List<java.lang.String> groups()A list of job groups. A job can belong to no groups or many.API name:
groups
-
jobId
public final java.lang.String jobId()Required - Identifier for the job.API name:
job_id
-
modelPlotConfig
API name:model_plot_config
-
modelSnapshotRetentionDays
@Nullable public final java.lang.Long 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
Settings related to how categorization interacts with partition fields.API name:
per_partition_categorization
-
renormalizationWindowDays
@Nullable public final java.lang.Long 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
@Nullable public final java.lang.Long 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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupUpdateJobRequestDeserializer
protected static void setupUpdateJobRequestDeserializer(ObjectDeserializer<UpdateJobRequest.Builder> op)
-