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

Class Bucket

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

  • Field Details

    • ANOMALY_SCORE

      public static final org.elasticsearch.xcontent.ParseField ANOMALY_SCORE

    • INITIAL_ANOMALY_SCORE

      public static final org.elasticsearch.xcontent.ParseField INITIAL_ANOMALY_SCORE

    • EVENT_COUNT

      public static final org.elasticsearch.xcontent.ParseField EVENT_COUNT

    • RECORDS

      public static final org.elasticsearch.xcontent.ParseField RECORDS

    • BUCKET_INFLUENCERS

      public static final org.elasticsearch.xcontent.ParseField BUCKET_INFLUENCERS

    • BUCKET_SPAN

      public static final org.elasticsearch.xcontent.ParseField BUCKET_SPAN

    • PROCESSING_TIME_MS

      public static final org.elasticsearch.xcontent.ParseField PROCESSING_TIME_MS

    • SCHEDULED_EVENTS

      public static final org.elasticsearch.xcontent.ParseField SCHEDULED_EVENTS

    • RESULTS_FIELD

      public static final org.elasticsearch.xcontent.ParseField RESULTS_FIELD

    • RESULT_TYPE_VALUE

      public static final String RESULT_TYPE_VALUE
      Result type
      See Also:

    • RESULT_TYPE_FIELD

      public static final org.elasticsearch.xcontent.ParseField RESULT_TYPE_FIELD

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<Bucket,Void> PARSER

  • Method Details

    • toXContent

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

    • getJobId

      public String getJobId()

    • getTimestamp

      public Date getTimestamp()

    • getBucketSpan

      public long getBucketSpan()
      Bucketspan expressed in seconds

    • getAnomalyScore

      public double getAnomalyScore()

    • getInitialAnomalyScore

      public double getInitialAnomalyScore()

    • getRecords

      public 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 List<BucketInfluencer> getBucketInfluencers()

    • getScheduledEvents

      public List<String> getScheduledEvents()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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