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

Class Bucket

java.lang.Object
org.elasticsearch.client.ml.job.results.Bucket
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class Bucket
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject
Bucket Result POJO

  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField ANOMALY_SCORE  
    static org.elasticsearch.common.ParseField BUCKET_INFLUENCERS  
    static org.elasticsearch.common.ParseField BUCKET_SPAN  
    static org.elasticsearch.common.ParseField EVENT_COUNT  
    static org.elasticsearch.common.ParseField INITIAL_ANOMALY_SCORE  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<Bucket,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField PROCESSING_TIME_MS  
    static org.elasticsearch.common.ParseField RECORDS  
    static org.elasticsearch.common.ParseField RESULT_TYPE_FIELD  
    static java.lang.String RESULT_TYPE_VALUE
    Result type
    static org.elasticsearch.common.ParseField RESULTS_FIELD  
    static org.elasticsearch.common.ParseField SCHEDULED_EVENTS  

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)
    Compare all the fields and embedded anomaly records (if any)
    double getAnomalyScore()  
    java.util.List<BucketInfluencer> getBucketInfluencers()  
    long getBucketSpan()
    Bucketspan expressed in seconds
    long getEventCount()
    The number of records (events) actually processed in this bucket.
    double getInitialAnomalyScore()  
    java.lang.String getJobId()  
    long getProcessingTimeMs()  
    java.util.List<AnomalyRecord> getRecords()
    Get all the anomaly records associated with this bucket.
    java.util.List<java.lang.String> getScheduledEvents()  
    java.util.Date getTimestamp()  
    int hashCode()  
    boolean isInterim()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 Details

    • ANOMALY_SCORE

      public static final org.elasticsearch.common.ParseField ANOMALY_SCORE

    • INITIAL_ANOMALY_SCORE

      public static final org.elasticsearch.common.ParseField INITIAL_ANOMALY_SCORE

    • EVENT_COUNT

      public static final org.elasticsearch.common.ParseField EVENT_COUNT

    • RECORDS

      public static final org.elasticsearch.common.ParseField RECORDS

    • BUCKET_INFLUENCERS

      public static final org.elasticsearch.common.ParseField BUCKET_INFLUENCERS

    • BUCKET_SPAN

      public static final org.elasticsearch.common.ParseField BUCKET_SPAN

    • PROCESSING_TIME_MS

      public static final org.elasticsearch.common.ParseField PROCESSING_TIME_MS

    • SCHEDULED_EVENTS

      public static final org.elasticsearch.common.ParseField SCHEDULED_EVENTS

    • RESULTS_FIELD

      public static final org.elasticsearch.common.ParseField RESULTS_FIELD

    • RESULT_TYPE_VALUE

      public static final java.lang.String RESULT_TYPE_VALUE
      Result type
      See Also:
      Constant Field Values

    • RESULT_TYPE_FIELD

      public static final org.elasticsearch.common.ParseField RESULT_TYPE_FIELD

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<Bucket,​java.lang.Void> PARSER

  • Method Details

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • getJobId

      public java.lang.String getJobId()

    • getTimestamp

      public java.util.Date getTimestamp()

    • getBucketSpan

      public long getBucketSpan()
      Bucketspan expressed in seconds

    • getAnomalyScore

      public double getAnomalyScore()

    • getInitialAnomalyScore

      public double getInitialAnomalyScore()

    • getRecords

      public java.util.List<AnomalyRecord> getRecords()
      Get all the anomaly records associated with this bucket. The records are not part of the bucket document. They will only be present when the bucket was retrieved and expanded to contain the associated records.
      Returns:
      the anomaly records for the bucket IF the bucket was expanded.

    • getEventCount

      public long getEventCount()
      The number of records (events) actually processed in this bucket.

    • isInterim

      public boolean isInterim()

    • getProcessingTimeMs

      public long getProcessingTimeMs()

    • getBucketInfluencers

      public java.util.List<BucketInfluencer> getBucketInfluencers()

    • getScheduledEvents

      public java.util.List<java.lang.String> getScheduledEvents()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object other)
      Compare all the fields and embedded anomaly records (if any)
      Overrides:
      equals in class java.lang.Object