Package org.elasticsearch.client.ml.job.process

Class DataCounts

java.lang.Object
org.elasticsearch.client.ml.job.process.DataCounts
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class DataCounts
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject
Job processed record counts.

The getInput... methods return the actual number of fields/records sent the API including invalid records. The getProcessed... methods are the number sent to the Engine.

The inputRecordCount field is calculated so it should not be set in deserialization but it should be serialised so the field is visible.

  • 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 BUCKET_COUNT  
    static org.elasticsearch.common.ParseField EARLIEST_RECORD_TIME  
    static org.elasticsearch.common.ParseField EMPTY_BUCKET_COUNT  
    static org.elasticsearch.common.ParseField INPUT_BYTES  
    static org.elasticsearch.common.ParseField INPUT_FIELD_COUNT  
    static org.elasticsearch.common.ParseField INPUT_RECORD_COUNT  
    static org.elasticsearch.common.ParseField INVALID_DATE_COUNT  
    static org.elasticsearch.common.ParseField LAST_DATA_TIME  
    static org.elasticsearch.common.ParseField LATEST_EMPTY_BUCKET_TIME  
    static org.elasticsearch.common.ParseField LATEST_RECORD_TIME  
    static org.elasticsearch.common.ParseField LATEST_SPARSE_BUCKET_TIME  
    static org.elasticsearch.common.ParseField LOG_TIME  
    static org.elasticsearch.common.ParseField MISSING_FIELD_COUNT  
    static org.elasticsearch.common.ParseField OUT_OF_ORDER_TIME_COUNT  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<DataCounts,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField PROCESSED_FIELD_COUNT  
    static org.elasticsearch.common.ParseField PROCESSED_RECORD_COUNT  
    static org.elasticsearch.common.ParseField SPARSE_BUCKET_COUNT  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    DataCounts​(java.lang.String jobId, long processedRecordCount, long processedFieldCount, long inputBytes, long inputFieldCount, long invalidDateCount, long missingFieldCount, long outOfOrderTimeStampCount, long emptyBucketCount, long sparseBucketCount, long bucketCount, java.util.Date earliestRecordTimeStamp, java.util.Date latestRecordTimeStamp, java.util.Date lastDataTimeStamp, java.util.Date latestEmptyBucketTimeStamp, java.util.Date latestSparseBucketTimeStamp, java.time.Instant logTime)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)
    Equality test
    long getBucketCount()
    The number of buckets overall.
    java.util.Date getEarliestRecordTimeStamp()
    The time of the first record seen.
    long getEmptyBucketCount()
    The number of buckets with no records in it.
    long getInputBytes()
    The total number of bytes sent to this job.
    long getInputFieldCount()
    The total number of fields sent to the job including fields that aren't analysed.
    long getInputRecordCount()
    Total number of input records read.
    long getInvalidDateCount()
    The number of records with an invalid date field that could not be parsed or converted to epoch time.
    java.lang.String getJobId()  
    java.util.Date getLastDataTimeStamp()
    The wall clock time the latest record was seen.
    java.util.Date getLatestEmptyBucketTimeStamp()
    The time of the latest empty bucket seen.
    java.util.Date getLatestRecordTimeStamp()
    The time of the latest record seen.
    java.util.Date getLatestSparseBucketTimeStamp()
    The time of the latest sparse bucket seen.
    java.time.Instant getLogTime()
    The wall clock time at the point when this instance was created.
    long getMissingFieldCount()
    The number of missing fields that had been configured for analysis.
    long getOutOfOrderTimeStampCount()
    The number of records with a timestamp that is before the time of the latest record.
    long getProcessedFieldCount()
    Number of data points (processed record count * the number of analysed fields) processed by this job.
    long getProcessedRecordCount()
    Number of records processed by this job.
    long getSparseBucketCount()
    The number of buckets with few records compared to the overall counts.
    int hashCode()  
    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

    • PROCESSED_RECORD_COUNT

      public static final org.elasticsearch.common.ParseField PROCESSED_RECORD_COUNT

    • PROCESSED_FIELD_COUNT

      public static final org.elasticsearch.common.ParseField PROCESSED_FIELD_COUNT

    • INPUT_BYTES

      public static final org.elasticsearch.common.ParseField INPUT_BYTES

    • INPUT_RECORD_COUNT

      public static final org.elasticsearch.common.ParseField INPUT_RECORD_COUNT

    • INPUT_FIELD_COUNT

      public static final org.elasticsearch.common.ParseField INPUT_FIELD_COUNT

    • INVALID_DATE_COUNT

      public static final org.elasticsearch.common.ParseField INVALID_DATE_COUNT

    • MISSING_FIELD_COUNT

      public static final org.elasticsearch.common.ParseField MISSING_FIELD_COUNT

    • OUT_OF_ORDER_TIME_COUNT

      public static final org.elasticsearch.common.ParseField OUT_OF_ORDER_TIME_COUNT

    • EMPTY_BUCKET_COUNT

      public static final org.elasticsearch.common.ParseField EMPTY_BUCKET_COUNT

    • SPARSE_BUCKET_COUNT

      public static final org.elasticsearch.common.ParseField SPARSE_BUCKET_COUNT

    • BUCKET_COUNT

      public static final org.elasticsearch.common.ParseField BUCKET_COUNT

    • EARLIEST_RECORD_TIME

      public static final org.elasticsearch.common.ParseField EARLIEST_RECORD_TIME

    • LATEST_RECORD_TIME

      public static final org.elasticsearch.common.ParseField LATEST_RECORD_TIME

    • LAST_DATA_TIME

      public static final org.elasticsearch.common.ParseField LAST_DATA_TIME

    • LATEST_EMPTY_BUCKET_TIME

      public static final org.elasticsearch.common.ParseField LATEST_EMPTY_BUCKET_TIME

    • LATEST_SPARSE_BUCKET_TIME

      public static final org.elasticsearch.common.ParseField LATEST_SPARSE_BUCKET_TIME

    • LOG_TIME

      public static final org.elasticsearch.common.ParseField LOG_TIME

    • PARSER

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

  • Constructor Details

    • DataCounts

      public DataCounts​(java.lang.String jobId, long processedRecordCount, long processedFieldCount, long inputBytes, long inputFieldCount, long invalidDateCount, long missingFieldCount, long outOfOrderTimeStampCount, long emptyBucketCount, long sparseBucketCount, long bucketCount, java.util.Date earliestRecordTimeStamp, java.util.Date latestRecordTimeStamp, java.util.Date lastDataTimeStamp, java.util.Date latestEmptyBucketTimeStamp, java.util.Date latestSparseBucketTimeStamp, java.time.Instant logTime)

  • Method Details

    • getJobId

      public java.lang.String getJobId()

    • getProcessedRecordCount

      public long getProcessedRecordCount()
      Number of records processed by this job. This value is the number of records sent passed on to the engine i.e. getInputRecordCount() minus records with bad dates or out of order
      Returns:
      Number of records processed by this job long

    • getProcessedFieldCount

      public long getProcessedFieldCount()
      Number of data points (processed record count * the number of analysed fields) processed by this job. This count does not include the time field.
      Returns:
      Number of data points processed by this job long

    • getInputRecordCount

      public long getInputRecordCount()
      Total number of input records read. This = processed record count + date parse error records count + out of order record count.

      Records with missing fields are counted as they are still written.

      Returns:
      Total number of input records read long

    • getInputBytes

      public long getInputBytes()
      The total number of bytes sent to this job. This value includes the bytes from any records that have been discarded for any reason e.g. because the date cannot be read
      Returns:
      Volume in bytes

    • getInputFieldCount

      public long getInputFieldCount()
      The total number of fields sent to the job including fields that aren't analysed.
      Returns:
      The total number of fields sent to the job

    • getInvalidDateCount

      public long getInvalidDateCount()
      The number of records with an invalid date field that could not be parsed or converted to epoch time.
      Returns:
      The number of records with an invalid date field

    • getMissingFieldCount

      public long getMissingFieldCount()
      The number of missing fields that had been configured for analysis.
      Returns:
      The number of missing fields

    • getOutOfOrderTimeStampCount

      public long getOutOfOrderTimeStampCount()
      The number of records with a timestamp that is before the time of the latest record. Records should be in ascending chronological order
      Returns:
      The number of records with a timestamp that is before the time of the latest record

    • getEmptyBucketCount

      public long getEmptyBucketCount()
      The number of buckets with no records in it. Used to measure general data fitness and/or configuration problems (bucket span).
      Returns:
      Number of empty buckets processed by this job long

    • getSparseBucketCount

      public long getSparseBucketCount()
      The number of buckets with few records compared to the overall counts. Used to measure general data fitness and/or configuration problems (bucket span).
      Returns:
      Number of sparse buckets processed by this job long

    • getBucketCount

      public long getBucketCount()
      The number of buckets overall.
      Returns:
      Number of buckets processed by this job long

    • getEarliestRecordTimeStamp

      public java.util.Date getEarliestRecordTimeStamp()
      The time of the first record seen.
      Returns:
      The first record time

    • getLatestRecordTimeStamp

      public java.util.Date getLatestRecordTimeStamp()
      The time of the latest record seen.
      Returns:
      Latest record time

    • getLastDataTimeStamp

      public java.util.Date getLastDataTimeStamp()
      The wall clock time the latest record was seen.
      Returns:
      Wall clock time of the lastest record

    • getLatestEmptyBucketTimeStamp

      public java.util.Date getLatestEmptyBucketTimeStamp()
      The time of the latest empty bucket seen.
      Returns:
      Latest empty bucket time

    • getLatestSparseBucketTimeStamp

      public java.util.Date getLatestSparseBucketTimeStamp()
      The time of the latest sparse bucket seen.
      Returns:
      Latest sparse bucket time

    • getLogTime

      public java.time.Instant getLogTime()
      The wall clock time at the point when this instance was created.
      Returns:
      The wall clock time

    • 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

    • equals

      public boolean equals​(java.lang.Object other)
      Equality test
      Overrides:
      equals in class java.lang.Object

    • hashCode

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