Package co.elastic.clients.elasticsearch.ml

Class UpdateJobRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ml.UpdateJobRequest.Builder
All Implemented Interfaces:
ObjectBuilder<UpdateJobRequest>
Enclosing class:
UpdateJobRequest
public static class UpdateJobRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<UpdateJobRequest>
Builder for UpdateJobRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowLazyOpen

      public final UpdateJobRequest.Builder allowLazyOpen​(@Nullable java.lang.Boolean value)
      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. If false 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-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, 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

      public final UpdateJobRequest.Builder analysisLimits​(@Nullable AnalysisMemoryLimit value)
      API name: analysis_limits

    • analysisLimits

      public final UpdateJobRequest.Builder analysisLimits​(java.util.function.Function<AnalysisMemoryLimit.Builder,​ObjectBuilder<AnalysisMemoryLimit>> fn)
      API name: analysis_limits

    • backgroundPersistInterval

      public final UpdateJobRequest.Builder backgroundPersistInterval​(@Nullable Time value)
      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

      public final UpdateJobRequest.Builder categorizationFilters​(java.util.List<java.lang.String> list)
      API name: categorization_filters

      Adds all elements of list to categorizationFilters.

    • 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 to customSettings.

    • customSettings

      public final UpdateJobRequest.Builder customSettings​(java.lang.String key, JsonData value)
      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 to model_snapshot_retention_days. For jobs created before version 7.8.0, the default value matches model_snapshot_retention_days.

      API name: daily_model_snapshot_retention_after_days

    • description

      public final UpdateJobRequest.Builder description​(@Nullable java.lang.String value)
      A description of the job.

      API name: description

    • detectors

      public final UpdateJobRequest.Builder detectors​(java.util.List<Detector> list)
      An array of detector update objects.

      API name: detectors

      Adds all elements of list to detectors.

    • detectors

      public final UpdateJobRequest.Builder detectors​(Detector value, Detector... values)
      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

      public final UpdateJobRequest.Builder groups​(java.util.List<java.lang.String> list)
      A list of job groups. A job can belong to no groups or many.

      API name: groups

      Adds all elements of list to groups.

    • groups

      public final UpdateJobRequest.Builder groups​(java.lang.String value, java.lang.String... values)
      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

      public final UpdateJobRequest.Builder jobId​(java.lang.String value)
      Required - Identifier for the job.

      API name: job_id

    • modelPlotConfig

      public final UpdateJobRequest.Builder modelPlotConfig​(@Nullable ModelPlotConfig value)
      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

      public final UpdateJobRequest.Builder modelSnapshotRetentionDays​(@Nullable java.lang.Long value)
      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

      public final UpdateJobRequest.Builder renormalizationWindowDays​(@Nullable java.lang.Long value)
      Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.

      API name: renormalization_window_days

    • resultsRetentionDays

      public final UpdateJobRequest.Builder resultsRetentionDays​(@Nullable java.lang.Long value)
      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

      public UpdateJobRequest build()
      Builds a UpdateJobRequest.
      Specified by:
      build in interface ObjectBuilder<UpdateJobRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.