Package co.elastic.clients.elasticsearch.ml

Class Job

java.lang.Object
co.elastic.clients.elasticsearch.ml.Job
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class Job extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static Job of(Function<Job.Builder,ObjectBuilder<Job>> fn)

    • allowLazyOpen

      public final boolean allowLazyOpen()
      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 AnalysisConfig analysisConfig()
      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

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

      @Nullable public final Time 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.

      API name: background_persist_interval

    • blocked

      @Nullable public final JobBlocked blocked()
      API name: blocked

    • createTime

      @Nullable public final DateTime createTime()
      API name: create_time

    • customSettings

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

      API name: custom_settings

    • dailyModelSnapshotRetentionAfterDays

      @Nullable public final 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 to model_snapshot_retention_days.

      API name: daily_model_snapshot_retention_after_days

    • dataDescription

      public final DataDescription dataDescription()
      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

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

      @Nullable public final Boolean deleting()
      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

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

      API name: description

    • finishedTime

      @Nullable public final DateTime finishedTime()
      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 List<String> groups()
      A list of job groups. A job can belong to no groups or many.

      API name: groups

    • jobId

      public final String jobId()
      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

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

      API name: job_type

    • jobVersion

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

      API name: job_version

    • modelPlotConfig

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

      @Nullable public final String modelSnapshotId()
      API name: model_snapshot_id

    • modelSnapshotRetentionDays

      public final long modelSnapshotRetentionDays()
      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

      @Nullable public final Long renormalizationWindowDays()
      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 String resultsIndexName()
      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

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

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupJobDeserializer

      protected static void setupJobDeserializer(ObjectDeserializer<Job.Builder> op)