Packagecom.amazonaws.services.cloudwatch.model
Classpublic class MetricDatum
InheritanceMetricDatum Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 4
Since : July 12. 2011
Runtime Versions : Flash Player 10.1, AIR 2.5

The MetricDatum data type encapsulates the information sent with PutMetricData to either create a new metric or add new values to be aggregated into an existing metric.



Public Methods
 MethodDefined By
  
Default C'tor.
MetricDatum
  
A list of dimensions (com.amazonaws.services.cloudwatch.model.Dimension) associated with the metric.
MetricDatum
  
getMetricName():String
The name of the metric.
MetricDatum
  
A set of statistical values describing the metric.
MetricDatum
  
The time stamp used for the metric.
MetricDatum
  
getUnit():String
The unit of the metric.
MetricDatum
  
getValue():Number
The value for the metric.
MetricDatum
  
setDimensions(dimensions:Array):void
A list of dimensions (com.amazonaws.services.cloudwatch.model.Dimension) associated with the metric.
MetricDatum
  
setMetricName(metricName:String):void
The name of the metric.
MetricDatum
  
setStatisticValues(statisticValues:StatisticSet):void
A set of statistical values describing the metric.
MetricDatum
  
setTimestamp(timestamp:Date):void
The timestamp used for the metric.
MetricDatum
  
setUnit(unit:String):void
The unit of the metric.
MetricDatum
  
setValue(value:Number):void
The value for the metric.
MetricDatum
  
toString():String
Returns a string representation of this object; useful for testing and debugging.
MetricDatum
  
withDimensions(dimensions:Array):MetricDatum
A list of dimensions associated with the metric.
MetricDatum
  
withMetricName(metricName:String):MetricDatum
The name of the metric.
MetricDatum
  
A set of statistical values describing the metric.
MetricDatum
  
withTimestamp(timestamp:Date):MetricDatum
The time stamp used for the metric.
MetricDatum
  
withUnit(unit:String):MetricDatum
The unit of the metric.
MetricDatum
  
withValue(value:Number):MetricDatum
The value for the metric.
MetricDatum
Constructor Detail
MetricDatum()Constructor
public function MetricDatum()

Default C'tor.

Method Detail
getDimensions()method
public function getDimensions():Array

A list of dimensions (com.amazonaws.services.cloudwatch.model.Dimension) associated with the metric.

Length: 0 - 10

Returns
Array — A list of dimensions (com.amazonaws.services.cloudwatch.model.Dimension instances) associated with the metric.

See also

getMetricName()method 
public function getMetricName():String

The name of the metric.

Length: 1 - 255

Returns
String — The name of the metric.
getStatisticValues()method 
public function getStatisticValues():StatisticSet

A set of statistical values describing the metric.

Returns
StatisticSet — A set of statistical values describing the metric.

See also

getTimestamp()method 
public function getTimestamp():Date

The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received.

Returns
Date — The timestamp used for the metric. If not specified, the default value is set to the time the metric data was received.
getUnit()method 
public function getUnit():String

The unit of the metric.

Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Returns
String — The unit of the metric.

See also

com.amazonaws.services.cloudwatch.model.StandardUnitEnum
getValue()method 
public function getValue():Number

The value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.

Returns
Number — The value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.
setDimensions()method 
public function setDimensions(dimensions:Array):void

A list of dimensions (com.amazonaws.services.cloudwatch.model.Dimension) associated with the metric.

Length: 0 - 10

Parameters

dimensions:Array — A list of dimensions (com.amazonaws.services.cloudwatch.model.Dimension instances) associated with the metric.

See also

setMetricName()method 
public function setMetricName(metricName:String):void

The name of the metric.

Length: 1 - 255

Parameters

metricName:String — The name of the metric.

setStatisticValues()method 
public function setStatisticValues(statisticValues:StatisticSet):void

A set of statistical values describing the metric.

Parameters

statisticValues:StatisticSet — A set of statistical values describing the metric.

setTimestamp()method 
public function setTimestamp(timestamp:Date):void

The timestamp used for the metric. If not specified, the default value is set to the time the metric data was received.

Parameters

timestamp:Date — The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received.

setUnit()method 
public function setUnit(unit:String):void

The unit of the metric.

Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Parameters

unit:String — The unit of the metric.

See also

com.amazonaws.services.cloudwatch.model.StandardUnitEnum
setValue()method 
public function setValue(value:Number):void

The value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.

Parameters

value:Number — value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.

toString()method 
public function toString():String

Returns a string representation of this object; useful for testing and debugging.

Returns
String — A string representation of this object.
withDimensions()method 
public function withDimensions(dimensions:Array):MetricDatum

A list of dimensions associated with the metric. Returns a reference to this object so that method calls can be chained together.

Length: 0 - 10

Parameters

dimensions:Array — A list of dimensions (com.amazonaws.services.cloudwatch.model.Dimension instances) associated with the metric.

Returns
MetricDatum — A reference to this updated object so that method calls can be chained together.

See also

withMetricName()method 
public function withMetricName(metricName:String):MetricDatum

The name of the metric. Returns a reference to this object so that method calls can be chained together.

Length: 1 - 255

Parameters

metricName:String — The name of the metric.

Returns
MetricDatum — A reference to this updated object so that method calls can be chained together.
withStatisticValues()method 
public function withStatisticValues(statisticValues:StatisticSet):MetricDatum

A set of statistical values describing the metric. Returns a reference to this object so that method calls can be chained together.

Parameters

statisticValues:StatisticSet — A set of statistical values describing the metric.

Returns
MetricDatum — A reference to this updated object so that method calls can be chained together.
withTimestamp()method 
public function withTimestamp(timestamp:Date):MetricDatum

The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received. Returns a reference to this object so that method calls can be chained together.

Parameters

timestamp:Date — The timestamp used for the metric. If not specified, the default value is set to the time the metric data was received.

Returns
MetricDatum — A reference to this updated object so that method calls can be chained together.
withUnit()method 
public function withUnit(unit:String):MetricDatum

The unit of the metric. Returns a reference to this object so that method calls can be chained together.

Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Parameters

unit:String — The unit of the metric.

Returns
MetricDatum — A reference to this updated object so that method calls can be chained together.

See also

com.amazonaws.services.cloudwatch.model.StandardUnitEnum
withValue()method 
public function withValue(value:Number):MetricDatum

The value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.

Returns a reference to this object so that method calls can be chained together.

Parameters

value:Number — value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.

Returns
MetricDatum — A reference to this updated object so that method calls can be chained together.