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

Class ForecastStats

java.lang.Object

org.elasticsearch.client.ml.job.stats.ForecastStats

All Implemented Interfaces:

ToXContent, ToXContentObject

public class ForecastStats
extends java.lang.Object
implements ToXContentObject

A class to hold statistics about forecasts.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	FORECASTED_JOBS
static ParseField	MEMORY_BYTES
static ConstructingObjectParser<ForecastStats,java.lang.Void>	PARSER
static ParseField	PROCESSING_TIME_MS
static ParseField	RECORDS
static ParseField	STATUS
static 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()
XContentBuilder	toXContent(XContentBuilder builder, 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 Detail

TOTAL

public static final ParseField TOTAL

FORECASTED_JOBS

public static final ParseField FORECASTED_JOBS

MEMORY_BYTES

public static final ParseField MEMORY_BYTES

PROCESSING_TIME_MS

public static final ParseField PROCESSING_TIME_MS

RECORDS

public static final ParseField RECORDS

STATUS

public static final ParseField STATUS

PARSER

public static final ConstructingObjectParser<ForecastStats,java.lang.Void> PARSER

Constructor Detail

ForecastStats

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

Method Detail

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 XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface 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