Package co.elastic.clients.elasticsearch.ml

Class Job.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowLazyOpen

      public final Job.Builder allowLazyOpen(boolean value)
      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

      public final Job.Builder analysisConfig(AnalysisConfig value)
      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

      public final Job.Builder analysisLimits(@Nullable AnalysisLimits value)
      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

      public final Job.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.

      API name: background_persist_interval

    • backgroundPersistInterval

      public final Job.Builder backgroundPersistInterval(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.

      API name: background_persist_interval

    • blocked

      public final Job.Builder blocked(@Nullable JobBlocked value)
      API name: blocked

    • blocked

      public final Job.Builder blocked(Function<JobBlocked.Builder,ObjectBuilder<JobBlocked>> fn)
      API name: blocked

    • createTime

      public final Job.Builder createTime(@Nullable DateTime value)
      API name: create_time

    • customSettings

      public final Job.Builder customSettings(@Nullable JsonData value)
      Advanced configuration option. Contains custom metadata about the job.

      API name: custom_settings

    • dailyModelSnapshotRetentionAfterDays

      public final Job.Builder dailyModelSnapshotRetentionAfterDays(@Nullable 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.

      API name: daily_model_snapshot_retention_after_days

    • dataDescription

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

      public final Job.Builder datafeedConfig(@Nullable Datafeed value)
      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

      public final Job.Builder datafeedConfig(Function<Datafeed.Builder,ObjectBuilder<Datafeed>> fn)
      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

      public final Job.Builder deleting(@Nullable Boolean value)
      Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when true.

      API name: deleting

    • description

      public final Job.Builder description(@Nullable String value)
      A description of the job.

      API name: description

    • finishedTime

      public final Job.Builder finishedTime(@Nullable DateTime value)
      If the job closed or failed, this is the time the job finished, otherwise it is null. This property is informational; you cannot change its value.

      API name: finished_time

    • groups

      public final Job.Builder groups(List<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 Job.Builder groups(String value, 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 Job.Builder jobId(String value)
      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

      public final Job.Builder jobType(@Nullable String value)
      Reserved for future use, currently set to anomaly_detector.

      API name: job_type

    • jobVersion

      public final Job.Builder jobVersion(@Nullable String value)
      The machine learning configuration version number at which the the job was created.

      API name: job_version

    • modelPlotConfig

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

      public final Job.Builder modelSnapshotId(@Nullable String value)
      API name: model_snapshot_id

    • modelSnapshotRetentionDays

      public final Job.Builder modelSnapshotRetentionDays(long value)
      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

      public final Job.Builder renormalizationWindowDays(@Nullable Long value)
      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 100 bucket_spans.

      API name: renormalization_window_days

    • resultsIndexName

      public final Job.Builder resultsIndexName(String value)
      Required - A text string that affects the name of the machine learning results index. The default value is shared, which generates an index named .ml-anomalies-shared.

      API name: results_index_name

    • resultsRetentionDays

      public final Job.Builder resultsRetentionDays(@Nullable 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. 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

      protected Job.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<Job.Builder>

    • build

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