Package org.elasticsearch.client.ml.job.stats

Class ForecastStats

java.lang.Object
org.elasticsearch.client.ml.job.stats.ForecastStats
All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class ForecastStats extends Object implements org.elasticsearch.xcontent.ToXContentObject
A class to hold statistics about forecasts.

  • Nested Class Summary

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

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    FORECASTED_JOBS
     
    static final org.elasticsearch.xcontent.ParseField
    MEMORY_BYTES
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<ForecastStats,Void>
    PARSER
     
    static final org.elasticsearch.xcontent.ParseField
    PROCESSING_TIME_MS
     
    static final org.elasticsearch.xcontent.ParseField
    RECORDS
     
    static final org.elasticsearch.xcontent.ParseField
    STATUS
     
    static final org.elasticsearch.xcontent.ParseField
    TOTAL
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ForecastStats(long total, SimpleStats memoryStats, SimpleStats recordStats, SimpleStats runtimeStats, Map<String,Long> statusCounts)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    long
    getForecastedJobs()
    The number of jobs that have at least one forecast.
    SimpleStats
    getMemoryStats()
    Statistics about the memory usage: minimum, maximum, average and total.
    SimpleStats
    getRecordStats()
    Statistics about the number of forecast records: minimum, maximum, average and total.
    SimpleStats
    getRuntimeStats()
    Statistics about the forecast runtime in milliseconds: minimum, maximum, average and total
    Map<String,Long>
    getStatusCounts()
    Counts per forecast status, for example: {"finished" : 2}.
    long
    getTotal()
    The number of forecasts currently available for this model.
    int
    hashCode()
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.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.xcontent.ToXContentObject

    isFragment

  • Field Details

    • TOTAL

      public static final org.elasticsearch.xcontent.ParseField TOTAL

    • FORECASTED_JOBS

      public static final org.elasticsearch.xcontent.ParseField FORECASTED_JOBS

    • MEMORY_BYTES

      public static final org.elasticsearch.xcontent.ParseField MEMORY_BYTES

    • PROCESSING_TIME_MS

      public static final org.elasticsearch.xcontent.ParseField PROCESSING_TIME_MS

    • RECORDS

      public static final org.elasticsearch.xcontent.ParseField RECORDS

    • STATUS

      public static final org.elasticsearch.xcontent.ParseField STATUS

    • PARSER

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

  • Constructor Details

  • Method Details

    • getTotal

      public long getTotal()
      The number of forecasts currently available for this model.

    • getForecastedJobs

      public long getForecastedJobs()
      The number of jobs that have at least one forecast.

    • getMemoryStats

      public SimpleStats getMemoryStats()
      Statistics about the memory usage: minimum, maximum, average and total.

    • getRecordStats

      public SimpleStats getRecordStats()
      Statistics about the number of forecast records: minimum, maximum, average and total.

    • getRuntimeStats

      public SimpleStats getRuntimeStats()
      Statistics about the forecast runtime in milliseconds: minimum, maximum, average and total

    • getStatusCounts

      public Map<String,Long> getStatusCounts()
      Counts per forecast status, for example: {"finished" : 2}.

    • 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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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