Class PutJobRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.PutJobRequest
All Implemented Interfaces:
JsonpSerializable

@JsonpDeserializable
public class PutJobRequest
extends RequestBase
implements JsonpSerializable
Instantiates an anomaly detection job.
See Also:
API specification
  • Field Details

  • Method Details

    • of

      public static PutJobRequest of​(java.util.function.Function<PutJobRequest.Builder,​ObjectBuilder<PutJobRequest>> fn)
    • allowLazyOpen

      @Nullable public final java.lang.Boolean allowLazyOpen()
      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. By default, if 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

    • analysisConfig

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

      public final Time backgroundPersistInterval()
      Required - 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 background_persist_interval value too low.

      API name: background_persist_interval

    • customSettings

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

      API name: custom_settings

    • dailyModelSnapshotRetentionAfterDays

      @Nullable public final java.lang.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 - Defines the format of the input data when you send data to the job by using the post data API. Note that when configure 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 DatafeedConfig datafeedConfig()
      Defines a datafeed for the anomaly detection job.

      API name: datafeed_config

    • description

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

      API name: description

    • groups

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

      API name: groups

    • jobId

      public final java.lang.String jobId()
      Required - The 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

    • 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. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.

      API name: model_plot_config

    • modelSnapshotRetentionDays

      @Nullable public final 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. By default, snapshots ten days older than the newest snapshot are deleted.

      API name: model_snapshot_retention_days

    • renormalizationWindowDays

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

      @Nullable public final java.lang.String resultsIndexName()
      A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared.

      API name: results_index_name

    • resultsRetentionDays

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

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

      protected static void setupPutJobRequestDeserializer​(ObjectDeserializer<PutJobRequest.Builder> op)