Package co.elastic.clients.elasticsearch.ml

Class UpdateJobRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • jobId

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

      API name: job_id

    • allowLazyOpen

      public UpdateJobRequest.Builder allowLazyOpen​(@Nullable java.lang.Boolean value)
      API name: allow_lazy_open

    • analysisLimits

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

    • analysisLimits

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

    • backgroundPersistInterval

      public UpdateJobRequest.Builder backgroundPersistInterval​(@Nullable java.lang.String 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

    • customSettings

      public UpdateJobRequest.Builder customSettings​(@Nullable java.util.Map<java.lang.String,​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

    • putCustomSettings

      public UpdateJobRequest.Builder putCustomSettings​(java.lang.String key, JsonData value)
      Add a key/value to customSettings(Map), creating the map if needed.

    • categorizationFilters

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

    • categorizationFilters

      public UpdateJobRequest.Builder categorizationFilters​(java.lang.String... value)
      API name: categorization_filters

    • addCategorizationFilters

      public UpdateJobRequest.Builder addCategorizationFilters​(java.lang.String value)
      Add a value to categorizationFilters(List), creating the list if needed.

    • description

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

      API name: description

    • modelPlotConfig

      public UpdateJobRequest.Builder modelPlotConfig​(@Nullable ModelPlotConfig value)
      API name: model_plot_config

    • modelPlotConfig

      public UpdateJobRequest.Builder modelPlotConfig​(java.util.function.Function<ModelPlotConfig.Builder,​ObjectBuilder<ModelPlotConfig>> fn)
      API name: model_plot_config

    • dailyModelSnapshotRetentionAfterDays

      public UpdateJobRequest.Builder dailyModelSnapshotRetentionAfterDays​(@Nullable java.lang.Long value)
      API name: daily_model_snapshot_retention_after_days

    • modelSnapshotRetentionDays

      public 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

    • renormalizationWindowDays

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

    • groups

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

      API name: groups

    • groups

      public UpdateJobRequest.Builder groups​(java.lang.String... value)
      A list of job groups. A job can belong to no groups or many.

      API name: groups

    • addGroups

      public UpdateJobRequest.Builder addGroups​(java.lang.String value)
      Add a value to groups(List), creating the list if needed.

    • detectors

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

      API name: detectors

    • detectors

      public UpdateJobRequest.Builder detectors​(Detector... value)
      An array of detector update objects.

      API name: detectors

    • addDetectors

      public UpdateJobRequest.Builder addDetectors​(Detector value)
      Add a value to detectors(List), creating the list if needed.

    • detectors

      public UpdateJobRequest.Builder detectors​(java.util.function.Function<Detector.Builder,​ObjectBuilder<Detector>> fn)
      Set detectors(List) to a singleton list.

    • addDetectors

      public UpdateJobRequest.Builder addDetectors​(java.util.function.Function<Detector.Builder,​ObjectBuilder<Detector>> fn)
      Add a value to detectors(List), creating the list if needed.

    • perPartitionCategorization

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

      API name: per_partition_categorization

    • perPartitionCategorization

      public 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

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