Package org.elasticsearch.client.ml.job.results

Class AnomalyRecord

java.lang.Object

org.elasticsearch.client.ml.job.results.AnomalyRecord

All Implemented Interfaces:

ToXContent, ToXContentObject

public class AnomalyRecord
extends java.lang.Object
implements ToXContentObject

Anomaly Record POJO. Uses the object wrappers Boolean and Double so null values can be returned if the members have not been set.

Nested Class Summary

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	ACTUAL
static ParseField	BUCKET_SPAN
static ParseField	BY_FIELD_NAME
static ParseField	BY_FIELD_VALUE
static ParseField	CAUSES
static ParseField	CORRELATED_BY_FIELD_VALUE
static ParseField	DETECTOR_INDEX
static ParseField	FIELD_NAME	Metric Results (including population metrics)
static ParseField	FUNCTION
static ParseField	FUNCTION_DESCRIPTION
static ParseField	INFLUENCERS
static ParseField	INITIAL_RECORD_SCORE
static ParseField	MULTI_BUCKET_IMPACT
static ParseField	OVER_FIELD_NAME	Population results
static ParseField	OVER_FIELD_VALUE
static ConstructingObjectParser<AnomalyRecord,java.lang.Void>	PARSER
static ParseField	PARTITION_FIELD_NAME
static ParseField	PARTITION_FIELD_VALUE
static ParseField	PROBABILITY	Result fields (all detector types)
static ParseField	RECORD_SCORE	Normalization
static java.lang.String	RESULT_TYPE_VALUE	Result type
static ParseField	RESULTS_FIELD
static ParseField	TYPICAL

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
java.util.List<java.lang.Double>	getActual()
long	getBucketSpan()	Bucketspan expressed in seconds
java.lang.String	getByFieldName()
java.lang.String	getByFieldValue()
java.util.List<AnomalyCause>	getCauses()
java.lang.String	getCorrelatedByFieldValue()
int	getDetectorIndex()
java.lang.String	getFieldName()
java.lang.String	getFunction()
java.lang.String	getFunctionDescription()
java.util.List<Influence>	getInfluencers()
double	getInitialRecordScore()
java.lang.String	getJobId()
double	getMultiBucketImpact()
java.lang.String	getOverFieldName()
java.lang.String	getOverFieldValue()
java.lang.String	getPartitionFieldName()
java.lang.String	getPartitionFieldValue()
double	getProbability()
double	getRecordScore()
java.util.Date	getTimestamp()
java.util.List<java.lang.Double>	getTypical()
int	hashCode()
boolean	isInterim()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

RESULT_TYPE_VALUE

public static final java.lang.String RESULT_TYPE_VALUE

Result type

See Also:

Constant Field Values

PROBABILITY

public static final ParseField PROBABILITY

Result fields (all detector types)

MULTI_BUCKET_IMPACT

public static final ParseField MULTI_BUCKET_IMPACT

DETECTOR_INDEX

public static final ParseField DETECTOR_INDEX

BY_FIELD_NAME

public static final ParseField BY_FIELD_NAME

BY_FIELD_VALUE

public static final ParseField BY_FIELD_VALUE

CORRELATED_BY_FIELD_VALUE

public static final ParseField CORRELATED_BY_FIELD_VALUE

PARTITION_FIELD_NAME

public static final ParseField PARTITION_FIELD_NAME

PARTITION_FIELD_VALUE

public static final ParseField PARTITION_FIELD_VALUE

FUNCTION

public static final ParseField FUNCTION

FUNCTION_DESCRIPTION

public static final ParseField FUNCTION_DESCRIPTION

TYPICAL

public static final ParseField TYPICAL

ACTUAL

public static final ParseField ACTUAL

INFLUENCERS

public static final ParseField INFLUENCERS

BUCKET_SPAN

public static final ParseField BUCKET_SPAN

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

FIELD_NAME

public static final ParseField FIELD_NAME

Metric Results (including population metrics)

OVER_FIELD_NAME

public static final ParseField OVER_FIELD_NAME

Population results

OVER_FIELD_VALUE

public static final ParseField OVER_FIELD_VALUE

CAUSES

public static final ParseField CAUSES

RECORD_SCORE

public static final ParseField RECORD_SCORE

Normalization

INITIAL_RECORD_SCORE

public static final ParseField INITIAL_RECORD_SCORE

PARSER

public static final ConstructingObjectParser<AnomalyRecord,java.lang.Void> PARSER

Method Detail

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

getJobId

public java.lang.String getJobId()

getDetectorIndex

public int getDetectorIndex()

getRecordScore

public double getRecordScore()

getInitialRecordScore

public double getInitialRecordScore()

getTimestamp

public java.util.Date getTimestamp()

getBucketSpan

public long getBucketSpan()

Bucketspan expressed in seconds

getProbability

public double getProbability()

getMultiBucketImpact

public double getMultiBucketImpact()

getByFieldName

public java.lang.String getByFieldName()

getByFieldValue

public java.lang.String getByFieldValue()

getCorrelatedByFieldValue

public java.lang.String getCorrelatedByFieldValue()

getPartitionFieldName

public java.lang.String getPartitionFieldName()

getPartitionFieldValue

public java.lang.String getPartitionFieldValue()

getFunction

public java.lang.String getFunction()

getFunctionDescription

public java.lang.String getFunctionDescription()

getTypical

public java.util.List<java.lang.Double> getTypical()

getActual

public java.util.List<java.lang.Double> getActual()

isInterim

public boolean isInterim()

getFieldName

public java.lang.String getFieldName()

getOverFieldName

public java.lang.String getOverFieldName()

getOverFieldValue

public java.lang.String getOverFieldValue()

getCauses

public java.util.List<AnomalyCause> getCauses()

getInfluencers

public java.util.List<Influence> getInfluencers()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object