com.amazonaws.services.cloudwatch.model

Class MetricDatum

java.lang.Object

com.amazonaws.services.cloudwatch.model.MetricDatum

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricDatum
extends Object
implements Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricDatum()

Method Summary

Modifier and Type	Method and Description
MetricDatum	clone()
boolean	equals(Object obj)
List<Dimension>	getDimensions() The dimensions associated with the metric.
String	getMetricName() The name of the metric.
StatisticSet	getStatisticValues() The statistical values for the metric.
Date	getTimestamp() The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
String	getUnit() The unit of the metric.
Double	getValue() The value for the metric.
int	hashCode()
void	setDimensions(Collection<Dimension> dimensions) The dimensions associated with the metric.
void	setMetricName(String metricName) The name of the metric.
void	setStatisticValues(StatisticSet statisticValues) The statistical values for the metric.
void	setTimestamp(Date timestamp) The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
void	setUnit(StandardUnit unit) The unit of the metric.
void	setUnit(String unit) The unit of the metric.
void	setValue(Double value) The value for the metric.
String	toString() Returns a string representation of this object; useful for testing and debugging.
MetricDatum	withDimensions(Collection<Dimension> dimensions) The dimensions associated with the metric.
MetricDatum	withDimensions(Dimension... dimensions) The dimensions associated with the metric.
MetricDatum	withMetricName(String metricName) The name of the metric.
MetricDatum	withStatisticValues(StatisticSet statisticValues) The statistical values for the metric.
MetricDatum	withTimestamp(Date timestamp) The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
MetricDatum	withUnit(StandardUnit unit) The unit of the metric.
MetricDatum	withUnit(String unit) The unit of the metric.
MetricDatum	withValue(Double value) The value for the metric.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricDatum

public MetricDatum()

Method Detail

setMetricName

public void setMetricName(String metricName)

The name of the metric.

Parameters:

metricName - The name of the metric.

getMetricName

public String getMetricName()

The name of the metric.

Returns:

The name of the metric.

withMetricName

public MetricDatum withMetricName(String metricName)

The name of the metric.

Parameters:

metricName - The name of the metric.

Returns:

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

getDimensions

public List<Dimension> getDimensions()

The dimensions associated with the metric.

Returns:

The dimensions associated with the metric.

setDimensions

public void setDimensions(Collection<Dimension> dimensions)

The dimensions associated with the metric.

Parameters:

dimensions - The dimensions associated with the metric.

withDimensions

public MetricDatum withDimensions(Dimension... dimensions)

The dimensions associated with the metric.

NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.

Parameters:

dimensions - The dimensions associated with the metric.

Returns:

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

withDimensions

public MetricDatum withDimensions(Collection<Dimension> dimensions)

The dimensions associated with the metric.

Parameters:

dimensions - The dimensions associated with the metric.

Returns:

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

setTimestamp

public void setTimestamp(Date timestamp)

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

Parameters:

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

getTimestamp

public Date getTimestamp()

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

Returns:

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

withTimestamp

public MetricDatum withTimestamp(Date timestamp)

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

Parameters:

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

Returns:

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

setValue

public void setValue(Double value)

The value for the metric.

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

Parameters:

value - The value for the metric.

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

getValue

public Double getValue()

The value for the metric.

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

Returns:

The value for the metric.

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

withValue

public MetricDatum withValue(Double value)

The value for the metric.

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

Parameters:

value - The value for the metric.

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

Returns:

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

setStatisticValues

public void setStatisticValues(StatisticSet statisticValues)

The statistical values for the metric.

Parameters:

statisticValues - The statistical values for the metric.

getStatisticValues

public StatisticSet getStatisticValues()

The statistical values for the metric.

Returns:

The statistical values for the metric.

withStatisticValues

public MetricDatum withStatisticValues(StatisticSet statisticValues)

The statistical values for the metric.

Parameters:

statisticValues - The statistical values for the metric.

Returns:

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

setUnit

public void setUnit(String unit)

The unit of the metric.

Parameters:

unit - The unit of the metric.

See Also:

StandardUnit

getUnit

public String getUnit()

The unit of the metric.

Returns:

The unit of the metric.

See Also:

StandardUnit

withUnit

public MetricDatum withUnit(String unit)

The unit of the metric.

Parameters:

unit - The unit of the metric.

Returns:

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

See Also:

StandardUnit

setUnit

public void setUnit(StandardUnit unit)

The unit of the metric.

Parameters:

unit - The unit of the metric.

See Also:

StandardUnit

withUnit

public MetricDatum withUnit(StandardUnit unit)

The unit of the metric.

Parameters:

unit - The unit of the metric.

Returns:

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

See Also:

StandardUnit

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MetricDatum clone()

Overrides:

clone in class Object