Class Job
- java.lang.Object
-
- org.elasticsearch.client.ml.job.config.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 arenull
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
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
Fields Modifier and Type Field Description static ParseField
ANALYSIS_CONFIG
static ParseField
ANALYSIS_LIMITS
static java.lang.String
ANOMALY_DETECTOR_JOB_TYPE
static ParseField
BACKGROUND_PERSIST_INTERVAL
static ParseField
CREATE_TIME
static ParseField
CUSTOM_SETTINGS
static ParseField
DATA_DESCRIPTION
static ParseField
DELETING
static ParseField
DESCRIPTION
static ParseField
ESTABLISHED_MODEL_MEMORY
static ParseField
FINISHED_TIME
static ParseField
GROUPS
static ParseField
ID
static ParseField
JOB_TYPE
static ParseField
LAST_DATA_TIME
static ParseField
MODEL_PLOT_CONFIG
static ParseField
MODEL_SNAPSHOT_ID
static ParseField
MODEL_SNAPSHOT_RETENTION_DAYS
static ObjectParser<Job.Builder,java.lang.Void>
PARSER
static ParseField
RENORMALIZATION_WINDOW_DAYS
static ParseField
RESULTS_INDEX_NAME
static 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)
AnalysisConfig
getAnalysisConfig()
The analysis configuration objectAnalysisLimits
getAnalysisLimits()
The analysis options objectTimeValue
getBackgroundPersistInterval()
The background persistence intervaljava.util.Date
getCreateTime()
The Job creation time.java.util.Map<java.lang.String,java.lang.Object>
getCustomSettings()
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.lang.Long
getEstablishedModelMemory()
The established model memory of the job, ornull
if model memory has not reached equilibrium yet.java.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()
java.util.Date
getLastDataTime()
The last time data was uploaded to the job ornull
if no data has been seen.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()
XContentBuilder
toXContent(XContentBuilder builder, 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 Detail
-
ANOMALY_DETECTOR_JOB_TYPE
public static final java.lang.String ANOMALY_DETECTOR_JOB_TYPE
- See Also:
- Constant Field Values
-
ID
public static final ParseField ID
-
JOB_TYPE
public static final ParseField JOB_TYPE
-
GROUPS
public static final ParseField GROUPS
-
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
-
LAST_DATA_TIME
public static final ParseField LAST_DATA_TIME
-
ESTABLISHED_MODEL_MEMORY
public static final ParseField ESTABLISHED_MODEL_MEMORY
-
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
-
PARSER
public static final ObjectParser<Job.Builder,java.lang.Void> PARSER
-
-
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 ornull
if not finished.- Returns:
- The date the job was last retired or
null
-
getLastDataTime
public java.util.Date getLastDataTime()
The last time data was uploaded to the job ornull
if no data has been seen.- Returns:
- The date at which the last data was processed
-
getEstablishedModelMemory
public java.lang.Long getEstablishedModelMemory()
The established model memory of the job, ornull
if model memory has not reached equilibrium yet.- Returns:
- The established model memory of the job
-
getAnalysisConfig
public AnalysisConfig getAnalysisConfig()
The analysis configuration object- Returns:
- The AnalysisConfig
-
getAnalysisLimits
public AnalysisLimits getAnalysisLimits()
The analysis options object- Returns:
- The AnalysisLimits
-
getModelPlotConfig
public ModelPlotConfig getModelPlotConfig()
-
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()
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- 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
public static Job.Builder builder(java.lang.String id)
-
-