Class Job
java.lang.Object
org.elasticsearch.client.ml.job.config.Job
- All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class Job
extends java.lang.Object
implements org.elasticsearch.common.xcontent.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.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Job.Builder
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
-
Field Summary
Fields Modifier and Type Field Description static org.elasticsearch.common.ParseField
ALLOW_LAZY_OPEN
static org.elasticsearch.common.ParseField
ANALYSIS_CONFIG
static org.elasticsearch.common.ParseField
ANALYSIS_LIMITS
static java.lang.String
ANOMALY_DETECTOR_JOB_TYPE
static org.elasticsearch.common.ParseField
BACKGROUND_PERSIST_INTERVAL
static org.elasticsearch.common.ParseField
CREATE_TIME
static org.elasticsearch.common.ParseField
CUSTOM_SETTINGS
static org.elasticsearch.common.ParseField
DAILY_MODEL_SNAPSHOT_RETENTION_AFTER_DAYS
static org.elasticsearch.common.ParseField
DATA_DESCRIPTION
static org.elasticsearch.common.ParseField
DELETING
static org.elasticsearch.common.ParseField
DESCRIPTION
static org.elasticsearch.common.ParseField
FINISHED_TIME
static org.elasticsearch.common.ParseField
GROUPS
static org.elasticsearch.common.ParseField
ID
static org.elasticsearch.common.ParseField
JOB_TYPE
static org.elasticsearch.common.ParseField
MODEL_PLOT_CONFIG
static org.elasticsearch.common.ParseField
MODEL_SNAPSHOT_ID
static org.elasticsearch.common.ParseField
MODEL_SNAPSHOT_RETENTION_DAYS
static org.elasticsearch.common.xcontent.ObjectParser<Job.Builder,java.lang.Void>
PARSER
static org.elasticsearch.common.ParseField
RENORMALIZATION_WINDOW_DAYS
static org.elasticsearch.common.ParseField
RESULTS_INDEX_NAME
static org.elasticsearch.common.ParseField
RESULTS_RETENTION_DAYS
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Method Summary
Modifier and Type Method Description static Job.Builder
builder(java.lang.String id)
boolean
equals(java.lang.Object other)
java.lang.Boolean
getAllowLazyOpen()
AnalysisConfig
getAnalysisConfig()
The analysis configuration objectAnalysisLimits
getAnalysisLimits()
The analysis options objectorg.elasticsearch.common.unit.TimeValue
getBackgroundPersistInterval()
The background persistence intervaljava.util.Date
getCreateTime()
The Job creation time.java.util.Map<java.lang.String,java.lang.Object>
getCustomSettings()
java.lang.Long
getDailyModelSnapshotRetentionAfterDays()
DataDescription
getDataDescription()
If not set the input data is assumed to be csv with a '_time' field in epoch format.java.lang.Boolean
getDeleting()
java.lang.String
getDescription()
The job descriptionjava.util.Date
getFinishedTime()
The time the job was finished ornull
if not finished.java.util.List<java.lang.String>
getGroups()
java.lang.String
getId()
Return the Job Id.java.lang.String
getJobType()
ModelPlotConfig
getModelPlotConfig()
java.lang.String
getModelSnapshotId()
java.lang.Long
getModelSnapshotRetentionDays()
java.lang.Long
getRenormalizationWindowDays()
The duration of the renormalization window in daysjava.lang.Long
getResultsRetentionDays()
int
hashCode()
java.lang.String
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
ANOMALY_DETECTOR_JOB_TYPE
public static final java.lang.String ANOMALY_DETECTOR_JOB_TYPE- See Also:
- Constant Field Values
-
ID
public static final org.elasticsearch.common.ParseField ID -
JOB_TYPE
public static final org.elasticsearch.common.ParseField JOB_TYPE -
GROUPS
public static final org.elasticsearch.common.ParseField GROUPS -
ANALYSIS_CONFIG
public static final org.elasticsearch.common.ParseField ANALYSIS_CONFIG -
ANALYSIS_LIMITS
public static final org.elasticsearch.common.ParseField ANALYSIS_LIMITS -
CREATE_TIME
public static final org.elasticsearch.common.ParseField CREATE_TIME -
CUSTOM_SETTINGS
public static final org.elasticsearch.common.ParseField CUSTOM_SETTINGS -
DATA_DESCRIPTION
public static final org.elasticsearch.common.ParseField DATA_DESCRIPTION -
DESCRIPTION
public static final org.elasticsearch.common.ParseField DESCRIPTION -
FINISHED_TIME
public static final org.elasticsearch.common.ParseField FINISHED_TIME -
MODEL_PLOT_CONFIG
public static final org.elasticsearch.common.ParseField MODEL_PLOT_CONFIG -
RENORMALIZATION_WINDOW_DAYS
public static final org.elasticsearch.common.ParseField RENORMALIZATION_WINDOW_DAYS -
BACKGROUND_PERSIST_INTERVAL
public static final org.elasticsearch.common.ParseField BACKGROUND_PERSIST_INTERVAL -
MODEL_SNAPSHOT_RETENTION_DAYS
public static final org.elasticsearch.common.ParseField MODEL_SNAPSHOT_RETENTION_DAYS -
DAILY_MODEL_SNAPSHOT_RETENTION_AFTER_DAYS
public static final org.elasticsearch.common.ParseField DAILY_MODEL_SNAPSHOT_RETENTION_AFTER_DAYS -
RESULTS_RETENTION_DAYS
public static final org.elasticsearch.common.ParseField RESULTS_RETENTION_DAYS -
MODEL_SNAPSHOT_ID
public static final org.elasticsearch.common.ParseField MODEL_SNAPSHOT_ID -
RESULTS_INDEX_NAME
public static final org.elasticsearch.common.ParseField RESULTS_INDEX_NAME -
DELETING
public static final org.elasticsearch.common.ParseField DELETING -
ALLOW_LAZY_OPEN
public static final org.elasticsearch.common.ParseField ALLOW_LAZY_OPEN -
PARSER
public static final org.elasticsearch.common.xcontent.ObjectParser<Job.Builder,java.lang.Void> PARSER
-
-
Method Details
-
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 ornull
if not finished.- Returns:
- The date the job was last retired or
null
-
getAnalysisConfig
The analysis configuration object- Returns:
- The AnalysisConfig
-
getAnalysisLimits
The analysis options object- Returns:
- The AnalysisLimits
-
getModelPlotConfig
-
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 org.elasticsearch.common.unit.TimeValue getBackgroundPersistInterval()The background persistence interval- Returns:
- background persistence interval
-
getModelSnapshotRetentionDays
public java.lang.Long getModelSnapshotRetentionDays() -
getDailyModelSnapshotRetentionAfterDays
public java.lang.Long getDailyModelSnapshotRetentionAfterDays() -
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() -
getAllowLazyOpen
public java.lang.Boolean getAllowLazyOpen() -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object other)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public final java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
builder
-