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

Class Job

  • All Implemented Interfaces:
    ToXContent, ToXContentObject
    public class Job
extends java.lang.Object
implements ToXContentObject
    This class represents a configured and created Job. The creation time is set to the time the object was constructed and the finished time and last data time fields are null until the job has seen some data or it is finished respectively.

    • Field Detail

      • ANOMALY_DETECTOR_JOB_TYPE

        public static final java.lang.String ANOMALY_DETECTOR_JOB_TYPE
        See Also:
        Constant Field Values

      • JOB_TYPE

        public static final ParseField JOB_TYPE

      • ANALYSIS_CONFIG

        public static final ParseField ANALYSIS_CONFIG

      • ANALYSIS_LIMITS

        public static final ParseField ANALYSIS_LIMITS

      • CREATE_TIME

        public static final ParseField CREATE_TIME

      • CUSTOM_SETTINGS

        public static final ParseField CUSTOM_SETTINGS

      • DATA_DESCRIPTION

        public static final ParseField DATA_DESCRIPTION

      • DESCRIPTION

        public static final ParseField DESCRIPTION

      • FINISHED_TIME

        public static final ParseField FINISHED_TIME

      • MODEL_PLOT_CONFIG

        public static final ParseField MODEL_PLOT_CONFIG

      • RENORMALIZATION_WINDOW_DAYS

        public static final ParseField RENORMALIZATION_WINDOW_DAYS

      • BACKGROUND_PERSIST_INTERVAL

        public static final ParseField BACKGROUND_PERSIST_INTERVAL

      • MODEL_SNAPSHOT_RETENTION_DAYS

        public static final ParseField MODEL_SNAPSHOT_RETENTION_DAYS

      • RESULTS_RETENTION_DAYS

        public static final ParseField RESULTS_RETENTION_DAYS

      • MODEL_SNAPSHOT_ID

        public static final ParseField MODEL_SNAPSHOT_ID

      • RESULTS_INDEX_NAME

        public static final ParseField RESULTS_INDEX_NAME

      • DELETING

        public static final ParseField DELETING

    • Method Detail

      • getId

        public java.lang.String getId()
        Return the Job Id.
        Returns:
        The job Id string

      • getJobType

        public java.lang.String getJobType()

      • getGroups

        public java.util.List<java.lang.String> getGroups()

      • getDescription

        public java.lang.String getDescription()
        The job description
        Returns:
        job description

      • getCreateTime

        public java.util.Date getCreateTime()
        The Job creation time. This name is preferred when serialising to the REST API.
        Returns:
        The date the job was created

      • getFinishedTime

        public java.util.Date getFinishedTime()
        The time the job was finished or null if not finished.
        Returns:
        The date the job was last retired or null

      • getAnalysisConfig

        public AnalysisConfig getAnalysisConfig()
        The analysis configuration object
        Returns:
        The AnalysisConfig

      • getAnalysisLimits

        public AnalysisLimits getAnalysisLimits()
        The analysis options object
        Returns:
        The AnalysisLimits

      • getDataDescription

        public DataDescription getDataDescription()
        If not set the input data is assumed to be csv with a '_time' field in epoch format.
        Returns:
        A DataDescription or null
        See Also:
        DataDescription

      • getRenormalizationWindowDays

        public java.lang.Long getRenormalizationWindowDays()
        The duration of the renormalization window in days
        Returns:
        renormalization window in days

      • getBackgroundPersistInterval

        public TimeValue getBackgroundPersistInterval()
        The background persistence interval
        Returns:
        background persistence interval

      • getModelSnapshotRetentionDays

        public java.lang.Long getModelSnapshotRetentionDays()

      • getResultsRetentionDays

        public java.lang.Long getResultsRetentionDays()

      • getCustomSettings

        public java.util.Map<java.lang.String,​java.lang.Object> getCustomSettings()

      • getModelSnapshotId

        public java.lang.String getModelSnapshotId()

      • getDeleting

        public java.lang.Boolean getDeleting()

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public final java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • builder

        public static Job.Builder builder​(java.lang.String id)