com.cloudera.api.model
Class ApiTimeSeriesAggregateStatistics

java.lang.Object
  com.cloudera.api.model.ApiTimeSeriesAggregateStatistics

public class ApiTimeSeriesAggregateStatistics
extends Object

Statistics related to one time series aggregate data point. It is available from v6 for data points containing aggregate data. It includes further statistics about the data point. An aggregate can be across entities (e.g., fd_open_across_datanodes), over time (e.g., a daily point for the fd_open metric for a specific DataNode), or both (e.g., a daily point for the fd_open_across_datanodes metric). If the data point is for non-aggregate date this will return null.

Constructor Summary

ApiTimeSeriesAggregateStatistics()

Method Summary

long	getCount() The number of individual data points aggregated in this data point.
ApiTimeSeriesCrossEntityMetadata	getCrossEntityMetadata() If the data-point is for a cross entity aggregate (e.g., fd_open_across_datanodes) returns the cross entity metadata, null otherwise.
double	getMax() This maximum value encountered while producing this aggregate data point.
Date	getMaxTime() The timestamp of the maximum data point.
double	getMean() The mean of the values of all data-points for this aggregate data point.
double	getMin() This minimum value encountered while producing this aggregate data point.
Date	getMinTime() The timestamp of the minimum data point.
Date	getSampleTime() The timestamp of the sample data point.
double	getSampleValue() The sample data point value representing an actual sample value picked from the underlying data that is being aggregated.
double	getStdDev() The standard deviation of the values of all data-points for this aggregate data point.
void	setCount(long count)
void	setCrossEntityMetadata(ApiTimeSeriesCrossEntityMetadata crossEntityMetadata)
void	setMax(double max)
void	setMaxTime(Date maxTime)
void	setMean(double mean)
void	setMin(double min)
void	setMinTime(Date minTime)
void	setSampleTime(Date sampleTime)
void	setSampleValue(double sampleValue)
void	setStdDev(double stdDev)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiTimeSeriesAggregateStatistics

public ApiTimeSeriesAggregateStatistics()

Method Detail

getSampleTime

public Date getSampleTime()

The timestamp of the sample data point. Note that the timestamp reflects coordinated universal time (UTC) and not necessarily the server's time zone. The rest API formats the UTC timestamp as an ISO-8061 string.

setSampleTime

public void setSampleTime(Date sampleTime)

getSampleValue

public double getSampleValue()

The sample data point value representing an actual sample value picked from the underlying data that is being aggregated.

setSampleValue

public void setSampleValue(double sampleValue)

getCount

public long getCount()

The number of individual data points aggregated in this data point.

setCount

public void setCount(long count)

getMin

public double getMin()

This minimum value encountered while producing this aggregate data point. If this is a cross-time aggregate then this is the minimum value encountered during the aggregation period. If this is a cross-entity aggregate then this is the minimum value encountered across all entities. If this is a cross-time, cross-entity aggregate, then this is the minimum value for any entity across the aggregation period.

setMin

public void setMin(double min)

getMinTime

public Date getMinTime()

The timestamp of the minimum data point. Note that the timestamp reflects coordinated universal time (UTC) and not necessarily the server's time zone. The rest API formats the UTC timestamp as an ISO-8061 string.

setMinTime

public void setMinTime(Date minTime)

getMax

public double getMax()

This maximum value encountered while producing this aggregate data point. If this is a cross-time aggregate then this is the maximum value encountered during the aggregation period. If this is a cross-entity aggregate then this is the maximum value encountered across all entities. If this is a cross-time, cross-entity aggregate, then this is the maximum value for any entity across the aggregation period.

setMax

public void setMax(double max)

getMaxTime

public Date getMaxTime()

The timestamp of the maximum data point. Note that the timestamp reflects coordinated universal time (UTC) and not necessarily the server's time zone. The rest API formats the UTC timestamp as an ISO-8061 string.

setMaxTime

public void setMaxTime(Date maxTime)

getMean

public double getMean()

The mean of the values of all data-points for this aggregate data point.

setMean

public void setMean(double mean)

getStdDev

public double getStdDev()

The standard deviation of the values of all data-points for this aggregate data point.

setStdDev

public void setStdDev(double stdDev)

getCrossEntityMetadata

public ApiTimeSeriesCrossEntityMetadata getCrossEntityMetadata()

If the data-point is for a cross entity aggregate (e.g., fd_open_across_datanodes) returns the cross entity metadata, null otherwise.

setCrossEntityMetadata

public void setCrossEntityMetadata(ApiTimeSeriesCrossEntityMetadata crossEntityMetadata)