Package org.elasticsearch.client.ml.job.config

Class JobUpdate.Builder

  • Enclosing class:
    JobUpdate
    public static class JobUpdate.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder​(java.lang.String jobId)
        New JobUpdate.Builder object for the existing job
        Parameters:
        jobId - non-null `jobId` for referencing an exising Job

    • Method Detail

      • setGroups

        public JobUpdate.Builder setGroups​(java.util.List<java.lang.String> groups)
        Set the job groups Updates the Job.groups setting
        Parameters:
        groups - A list of group names

      • setDescription

        public JobUpdate.Builder setDescription​(java.lang.String description)
        Set the job description Updates the Job.description setting
        Parameters:
        description - the desired Machine Learning job description

      • setModelPlotConfig

        public JobUpdate.Builder setModelPlotConfig​(ModelPlotConfig modelPlotConfig)
        Enables/disables the model plot config setting through ModelPlotConfig.enabled Updates the Job.modelPlotConfig setting
        Parameters:
        modelPlotConfig - ModelPlotConfig object with updated fields

      • setRenormalizationWindowDays

        public JobUpdate.Builder setRenormalizationWindowDays​(java.lang.Long renormalizationWindowDays)
        Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen Updates the Job.renormalizationWindowDays setting
        Parameters:
        renormalizationWindowDays - number of renormalization window days

      • setBackgroundPersistInterval

        public JobUpdate.Builder setBackgroundPersistInterval​(TimeValue backgroundPersistInterval)
        Advanced configuration option. The time between each periodic persistence of the model Updates the Job.backgroundPersistInterval setting
        Parameters:
        backgroundPersistInterval - the time between background persistence

      • setModelSnapshotRetentionDays

        public JobUpdate.Builder setModelSnapshotRetentionDays​(java.lang.Long modelSnapshotRetentionDays)
        The time in days that model snapshots are retained for the job. Updates the Job.modelSnapshotRetentionDays setting
        Parameters:
        modelSnapshotRetentionDays - number of days to keep a model snapshot

      • setResultsRetentionDays

        public JobUpdate.Builder setResultsRetentionDays​(java.lang.Long resultsRetentionDays)
        Advanced configuration option. The number of days for which job results are retained Updates the Job.resultsRetentionDays setting
        Parameters:
        resultsRetentionDays - number of days to keep results.

      • setCategorizationFilters

        public JobUpdate.Builder setCategorizationFilters​(java.util.List<java.lang.String> categorizationFilters)
        Sets the categorization filters on the Job Updates the AnalysisConfig.categorizationFilters setting. Requires AnalysisConfig.categorizationFieldName to have been set on the existing Job.
        Parameters:
        categorizationFilters - list of categorization filters for the Job's AnalysisConfig

      • setCustomSettings

        public JobUpdate.Builder setCustomSettings​(java.util.Map<java.lang.String,​java.lang.Object> customSettings)
        Contains custom meta data about the job. Updates the Job.customSettings setting
        Parameters:
        customSettings - custom settings map for the job