Module org.elasticsearch.xcore
Package org.elasticsearch.xpack.core.ml.job.results

Class AnomalyRecord

java.lang.Object
org.elasticsearch.xpack.core.ml.job.results.AnomalyRecord
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject
public class AnomalyRecord extends Object implements ToXContentObject, Writeable
Anomaly Record POJO. Uses the object wrappers Boolean and Double so null values can be returned if the members have not been set.

  • Field Details

    • RESULT_TYPE_VALUE

      public static final String RESULT_TYPE_VALUE
      Result type
      See Also:

    • PROBABILITY

      public static final ParseField PROBABILITY
      Result fields (all detector types)

    • MULTI_BUCKET_IMPACT

      public static final ParseField MULTI_BUCKET_IMPACT

    • 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

    • GEO_RESULTS

      public static final ParseField GEO_RESULTS

    • ANOMALY_SCORE_EXPLANATION

      public static final ParseField ANOMALY_SCORE_EXPLANATION

    • 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

    • STRICT_PARSER

      public static final ConstructingObjectParser<AnomalyRecord,Void> STRICT_PARSER

    • LENIENT_PARSER

      public static final ConstructingObjectParser<AnomalyRecord,Void> LENIENT_PARSER

  • Constructor Details

  • 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()

    • getId

      public String getId()
      Data store ID of this record.

    • getDetectorIndex

      public int getDetectorIndex()

    • setDetectorIndex

      public void setDetectorIndex(int detectorIndex)

    • getRecordScore

      public double getRecordScore()

    • setRecordScore

      public void setRecordScore(double recordScore)

    • getInitialRecordScore

      public double getInitialRecordScore()

    • setInitialRecordScore

      public void setInitialRecordScore(double initialRecordScore)

    • getTimestamp

      public Date getTimestamp()

    • getBucketSpan

      public long getBucketSpan()
      Bucketspan expressed in seconds

    • getProbability

      public double getProbability()

    • setProbability

      public void setProbability(double value)

    • getMultiBucketImpact

      public double getMultiBucketImpact()

    • setMultiBucketImpact

      public void setMultiBucketImpact(double value)

    • getByFieldName

      public String getByFieldName()

    • setByFieldName

      public void setByFieldName(String value)

    • getByFieldValue

      public String getByFieldValue()

    • setByFieldValue

      public void setByFieldValue(String value)

    • getCorrelatedByFieldValue

      public String getCorrelatedByFieldValue()

    • setCorrelatedByFieldValue

      public void setCorrelatedByFieldValue(String value)

    • getPartitionFieldName

      public String getPartitionFieldName()

    • setPartitionFieldName

      public void setPartitionFieldName(String field)

    • getPartitionFieldValue

      public String getPartitionFieldValue()

    • setPartitionFieldValue

      public void setPartitionFieldValue(String value)

    • getFunction

      public String getFunction()

    • setFunction

      public void setFunction(String name)

    • getFunctionDescription

      public String getFunctionDescription()

    • setFunctionDescription

      public void setFunctionDescription(String functionDescription)

    • getTypical

      public List<Double> getTypical()

    • setTypical

      public void setTypical(List<Double> typical)

    • getActual

      public List<Double> getActual()

    • setActual

      public void setActual(List<Double> actual)

    • isInterim

      public boolean isInterim()

    • setInterim

      public void setInterim(boolean interim)

    • getFieldName

      public String getFieldName()

    • setFieldName

      public void setFieldName(String field)

    • getOverFieldName

      public String getOverFieldName()

    • setOverFieldName

      public void setOverFieldName(String name)

    • getOverFieldValue

      public String getOverFieldValue()

    • setOverFieldValue

      public void setOverFieldValue(String value)

    • getCauses

      public List<AnomalyCause> getCauses()

    • setCauses

      public void setCauses(List<AnomalyCause> causes)

    • addCause

      public void addCause(AnomalyCause cause)

    • getInfluencers

      public List<Influence> getInfluencers()

    • setInfluencers

      public void setInfluencers(List<Influence> influencers)

    • getGeoResults

      public GeoResults getGeoResults()

    • setGeoResults

      public void setGeoResults(GeoResults geoResults)

    • getAnomalyScoreExplanation

      public AnomalyScoreExplanation getAnomalyScoreExplanation()

    • setAnomalyScoreExplanation

      public void setAnomalyScoreExplanation(AnomalyScoreExplanation anomalyScoreExplanation)

    • getEventIngested

      public Instant getEventIngested()

    • setEventIngested

      public void setEventIngested(Instant eventIngested)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object