Package co.elastic.clients.elasticsearch.ml

Class UpdateJobRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.UpdateJobRequest
All Implemented Interfaces:
ElasticsearchCommonRequest, JsonpSerializable
@JsonpDeserializable
public final class UpdateJobRequest
extends RequestBase
implements JsonpSerializable

  • Field Details

  • Constructor Details

  • Method Details

    • jobId

      public java.lang.String jobId()
      Identifier for the job

      API name: job_id

    • allowLazyOpen

      @Nullable public java.lang.Boolean allowLazyOpen()
      API name: allow_lazy_open

    • analysisLimits

      @Nullable public AnalysisMemoryLimit analysisLimits()
      API name: analysis_limits

    • backgroundPersistInterval

      @Nullable public java.lang.String 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

    • customSettings

      @Nullable public java.util.Map<java.lang.String,​JsonData> 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

    • categorizationFilters

      @Nullable public java.util.List<java.lang.String> categorizationFilters()
      API name: categorization_filters

    • description

      @Nullable public java.lang.String description()
      A description of the job.

      API name: description

    • modelPlotConfig

      @Nullable public ModelPlotConfig modelPlotConfig()
      API name: model_plot_config

    • dailyModelSnapshotRetentionAfterDays

      @Nullable public java.lang.Long dailyModelSnapshotRetentionAfterDays()
      API name: daily_model_snapshot_retention_after_days

    • modelSnapshotRetentionDays

      @Nullable public 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

    • renormalizationWindowDays

      @Nullable public 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 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

    • groups

      @Nullable public java.util.List<java.lang.String> groups()
      A list of job groups. A job can belong to no groups or many.

      API name: groups

    • detectors

      @Nullable public java.util.List<Detector> detectors()
      An array of detector update objects.

      API name: detectors

    • perPartitionCategorization

      @Nullable public PerPartitionCategorization perPartitionCategorization()
      Settings related to how categorization interacts with partition fields.

      API name: per_partition_categorization

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupUpdateJobRequestDeserializer

      protected static void setupUpdateJobRequestDeserializer​(DelegatingDeserializer<UpdateJobRequest.Builder> op)