Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.job.config

Class JobUpdate

java.lang.Object

org.elasticsearch.xpack.core.ml.job.config.JobUpdate

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class JobUpdate
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JobUpdate.Builder
static class	JobUpdate.DetectorUpdate

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	CLEAR_JOB_FINISH_TIME
static final ParseField	DETECTORS
static final ConstructingObjectParser<JobUpdate.Builder,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
JobUpdate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
Boolean	getAllowLazyOpen()
AnalysisLimits	getAnalysisLimits()
TimeValue	getBackgroundPersistInterval()
Blocked	getBlocked()
List<String>	getCategorizationFilters()
Boolean	getClearJobFinishTime()
Map<String,Object>	getCustomSettings()
Long	getDailyModelSnapshotRetentionAfterDays()
String	getDescription()
List<JobUpdate.DetectorUpdate>	getDetectorUpdates()
List<String>	getGroups()
String	getJobId()
MlConfigVersion	getJobVersion()
ModelPlotConfig	getModelPlotConfig()
TimeValue	getModelPruneWindow()
String	getModelSnapshotId()
MlConfigVersion	getModelSnapshotMinVersion()
Long	getModelSnapshotRetentionDays()
PerPartitionCategorizationConfig	getPerPartitionCategorizationConfig()
Long	getRenormalizationWindowDays()
Long	getResultsRetentionDays()
Set<String>	getUpdateFields()
int	hashCode()
boolean	isAutodetectProcessUpdate()
Job	mergeWithJob(Job source, ByteSizeValue maxModelMemoryLimit)	Updates source with the new values in this object returning a new Job.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

DETECTORS

public static final ParseField DETECTORS

CLEAR_JOB_FINISH_TIME

public static final ParseField CLEAR_JOB_FINISH_TIME

PARSER

public static final ConstructingObjectParser<JobUpdate.Builder,Void> PARSER

Constructor Details

JobUpdate

public JobUpdate(StreamInput in)
          throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getJobId

public String getJobId()

getGroups

public List<String> getGroups()

getDescription

public String getDescription()

getDetectorUpdates

public List<JobUpdate.DetectorUpdate> getDetectorUpdates()

getModelPlotConfig

public ModelPlotConfig getModelPlotConfig()

getAnalysisLimits

public AnalysisLimits getAnalysisLimits()

getRenormalizationWindowDays

public Long getRenormalizationWindowDays()

getBackgroundPersistInterval

public TimeValue getBackgroundPersistInterval()

getModelSnapshotRetentionDays

public Long getModelSnapshotRetentionDays()

getDailyModelSnapshotRetentionAfterDays

public Long getDailyModelSnapshotRetentionAfterDays()

getResultsRetentionDays

public Long getResultsRetentionDays()

getCategorizationFilters

public List<String> getCategorizationFilters()

getPerPartitionCategorizationConfig

public PerPartitionCategorizationConfig getPerPartitionCategorizationConfig()

getCustomSettings

public Map<String,Object> getCustomSettings()

getModelSnapshotId

public String getModelSnapshotId()

getModelSnapshotMinVersion

public MlConfigVersion getModelSnapshotMinVersion()

getJobVersion

public MlConfigVersion getJobVersion()

getClearJobFinishTime

public Boolean getClearJobFinishTime()

getAllowLazyOpen

public Boolean getAllowLazyOpen()

isAutodetectProcessUpdate

public boolean isAutodetectProcessUpdate()

getBlocked

public Blocked getBlocked()

getModelPruneWindow

public TimeValue getModelPruneWindow()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getUpdateFields

public Set<String> getUpdateFields()

mergeWithJob

public Job mergeWithJob(Job source,
 ByteSizeValue maxModelMemoryLimit)

Updates source with the new values in this object returning a new Job.

Parameters:

source - Source job to be updated

maxModelMemoryLimit - The maximum model memory allowed

Returns:

A new job equivalent to source updated.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object