Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.job.process.autodetect.state

Class ModelSnapshot

java.lang.Object

org.elasticsearch.xpack.core.ml.job.process.autodetect.state.ModelSnapshot

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class ModelSnapshot
extends Object
implements ToXContentObject, Writeable

ModelSnapshot Result POJO

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelSnapshot.Builder

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	DESCRIPTION
static final String	EMPTY_SNAPSHOT_ID
static final ParseField	LATEST_RECORD_TIME
static final ParseField	LATEST_RESULT_TIME
static final ObjectParser<ModelSnapshot.Builder,Void>	LENIENT_PARSER
static final ParseField	MIN_VERSION
static final ParseField	QUANTILES
static final ParseField	RESULTS_FIELD
static final ParseField	RETAIN
static final ParseField	SNAPSHOT_DOC_COUNT
static final ObjectParser<ModelSnapshot.Builder,Void>	STRICT_PARSER
static final ParseField	TIMESTAMP	Field Names
static final ParseField	TYPE	Legacy type, now used only as a discriminant in the document ID

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ModelSnapshot(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static String	annotationDocumentId(ModelSnapshot snapshot)
static String	documentId(String jobId, String snapshotId)
static String	documentId(ModelSnapshot snapshot)
static String	documentIdPrefix(String jobId)
static ModelSnapshot	emptySnapshot(String jobId)
boolean	equals(Object other)	Compare all the fields.
static ModelSnapshot	fromJson(BytesReference bytesReference)
String	getDescription()
String	getJobId()
Date	getLatestRecordTimeStamp()
Date	getLatestResultTimeStamp()
MlConfigVersion	getMinVersion()
ModelSizeStats	getModelSizeStats()
Quantiles	getQuantiles()
int	getSnapshotDocCount()
String	getSnapshotId()
Date	getTimestamp()
int	hashCode()
boolean	isRetain()
boolean	isTheEmptySnapshot()
static boolean	isTheEmptySnapshot(String snapshotId)
List<String>	stateDocumentIds()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static String	v54DocumentId(String jobId, String snapshotId)	This is how the IDs were formed in v5.4
static String	v54DocumentId(ModelSnapshot snapshot)	This is how the IDs were formed in v5.4
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

TIMESTAMP

public static final ParseField TIMESTAMP

Field Names

DESCRIPTION

public static final ParseField DESCRIPTION

SNAPSHOT_DOC_COUNT

public static final ParseField SNAPSHOT_DOC_COUNT

LATEST_RECORD_TIME

public static final ParseField LATEST_RECORD_TIME

LATEST_RESULT_TIME

public static final ParseField LATEST_RESULT_TIME

QUANTILES

public static final ParseField QUANTILES

RETAIN

public static final ParseField RETAIN

MIN_VERSION

public static final ParseField MIN_VERSION

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

TYPE

public static final ParseField TYPE

Legacy type, now used only as a discriminant in the document ID

STRICT_PARSER

public static final ObjectParser<ModelSnapshot.Builder,Void> STRICT_PARSER

LENIENT_PARSER

public static final ObjectParser<ModelSnapshot.Builder,Void> LENIENT_PARSER

EMPTY_SNAPSHOT_ID

public static final String EMPTY_SNAPSHOT_ID

See Also:

• Constant Field Values

Constructor Details

ModelSnapshot

public ModelSnapshot(StreamInput in)
              throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getJobId

public String getJobId()

getMinVersion

public MlConfigVersion getMinVersion()

getTimestamp

public Date getTimestamp()

getDescription

public String getDescription()

getSnapshotId

public String getSnapshotId()

getSnapshotDocCount

public int getSnapshotDocCount()

getModelSizeStats

public ModelSizeStats getModelSizeStats()

getQuantiles

public Quantiles getQuantiles()

getLatestRecordTimeStamp

public Date getLatestRecordTimeStamp()

getLatestResultTimeStamp

public Date getLatestResultTimeStamp()

isRetain

public boolean isRetain()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Compare all the fields.

Overrides:

equals in class Object

stateDocumentIds

public List<String> stateDocumentIds()

isTheEmptySnapshot

public boolean isTheEmptySnapshot()

isTheEmptySnapshot

public static boolean isTheEmptySnapshot(String snapshotId)

documentIdPrefix

public static String documentIdPrefix(String jobId)

annotationDocumentId

public static String annotationDocumentId(ModelSnapshot snapshot)

documentId

public static String documentId(ModelSnapshot snapshot)

v54DocumentId

public static String v54DocumentId(ModelSnapshot snapshot)

This is how the IDs were formed in v5.4

documentId

public static String documentId(String jobId,
 String snapshotId)

v54DocumentId

public static String v54DocumentId(String jobId,
 String snapshotId)

This is how the IDs were formed in v5.4

fromJson

public static ModelSnapshot fromJson(BytesReference bytesReference)

emptySnapshot

public static ModelSnapshot emptySnapshot(String jobId)