class Amazonite::CloudWatch::MetricDatum

Overview

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

Included Modules

Defined in:

cloudwatch/metric_datum.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(metric_name : String, dimensions : Array(Dimension) | Nil = nil, timestamp : Time | Nil = nil, value : Float64 | Nil = nil, statistic_values : StatisticSet | Nil = nil, values : Array(Float64) | Nil = nil, counts : Array(Float64) | Nil = nil, unit : StandardUnit | Nil = nil, storage_resolution : Int32 | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def counts : Array(Float64) | Nil #

Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.


[View source]
def counts=(counts : Array(Float64) | Nil) #

Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.


[View source]
def dimensions : Array(Dimension) | Nil #

The dimensions associated with the metric.


[View source]
def dimensions=(dimensions : Array(Dimension) | Nil) #

The dimensions associated with the metric.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def metric_name : String #

The name of the metric.


[View source]
def metric_name=(metric_name : String) #

The name of the metric.


[View source]
def statistic_values : StatisticSet | Nil #

The statistical values for the metric.


[View source]
def statistic_values=(statistic_values : StatisticSet | Nil) #

The statistical values for the metric.


[View source]
def storage_resolution : Int32 | Nil #

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

This field is optional, if you do not specify it the default of 60 is used.


[View source]
def storage_resolution=(storage_resolution : Int32 | Nil) #

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

This field is optional, if you do not specify it the default of 60 is used.


[View source]
def timestamp : Time | Nil #

The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.


[View source]
def timestamp=(timestamp : Time | Nil) #

The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.


[View source]
def unit : StandardUnit | Nil #

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, this displays the unit that is used for the metric.


[View source]
def unit=(unit : StandardUnit | Nil) #

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, this displays the unit that is used for the metric.


[View source]
def validate! : Nil #

[View source]
def value : Float64 | Nil #

The value for the metric.

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.


[View source]
def value=(value : Float64 | Nil) #

The value for the metric.

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.


[View source]
def values : Array(Float64) | Nil #

Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.


[View source]
def values=(values : Array(Float64) | Nil) #

Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.


[View source]