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

Class ForecastStats

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

  • 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 FORECASTED_JOBS  
    static org.elasticsearch.common.ParseField MEMORY_BYTES  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<ForecastStats,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField PROCESSING_TIME_MS  
    static org.elasticsearch.common.ParseField RECORDS  
    static org.elasticsearch.common.ParseField STATUS  
    static org.elasticsearch.common.ParseField TOTAL  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    ForecastStats​(long total, SimpleStats memoryStats, SimpleStats recordStats, SimpleStats runtimeStats, java.util.Map<java.lang.String,​java.lang.Long> statusCounts)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.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
    java.util.Map<java.lang.String,​java.lang.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.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

    • TOTAL

      public static final org.elasticsearch.common.ParseField TOTAL

    • FORECASTED_JOBS

      public static final org.elasticsearch.common.ParseField FORECASTED_JOBS

    • MEMORY_BYTES

      public static final org.elasticsearch.common.ParseField MEMORY_BYTES

    • PROCESSING_TIME_MS

      public static final org.elasticsearch.common.ParseField PROCESSING_TIME_MS

    • RECORDS

      public static final org.elasticsearch.common.ParseField RECORDS

    • STATUS

      public static final org.elasticsearch.common.ParseField STATUS

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<ForecastStats,​java.lang.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 java.util.Map<java.lang.String,​java.lang.Long> getStatusCounts()
      Counts per forecast status, for example: {"finished" : 2}.

    • 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

    • hashCode

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

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object