MetricDatum (AWS Java SDK for Amazon CloudWatch 1.12.415 API)

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()

Constructors
Constructor and Description
`MetricDatum()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricDatum`	`clone()`
`boolean`	`equals(Object obj)`
`List<Double>`	`getCounts()` Array of numbers that is used along with the `Values` array.
`List<Dimension>`	`getDimensions()` The dimensions associated with the metric.
`String`	`getMetricName()` The name of the metric.
`StatisticSet`	`getStatisticValues()` The statistical values for the metric.
`Integer`	`getStorageResolution()` Valid values are 1 and 60.
`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()` When you are using a `Put` operation, this defines what unit you want to use when storing the metric.
`Double`	`getValue()` The value for the metric.
`List<Double>`	`getValues()` Array of numbers representing the values for the metric during the period.
`int`	`hashCode()`
`void`	`setCounts(Collection<Double> counts)` Array of numbers that is used along with the `Values` array.
`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`	`setStorageResolution(Integer storageResolution)` Valid values are 1 and 60.
`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)` When you are using a `Put` operation, this defines what unit you want to use when storing the metric.
`void`	`setUnit(String unit)` When you are using a `Put` operation, this defines what unit you want to use when storing the metric.
`void`	`setValue(Double value)` The value for the metric.
`void`	`setValues(Collection<Double> values)` Array of numbers representing the values for the metric during the period.
`String`	`toString()` Returns a string representation of this object.
`MetricDatum`	`withCounts(Collection<Double> counts)` Array of numbers that is used along with the `Values` array.
`MetricDatum`	`withCounts(Double... counts)` Array of numbers that is used along with the `Values` array.
`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`	`withStorageResolution(Integer storageResolution)` Valid values are 1 and 60.
`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)` When you are using a `Put` operation, this defines what unit you want to use when storing the metric.
`MetricDatum`	`withUnit(String unit)` When you are using a `Put` operation, this defines what unit you want to use when storing the metric.
`MetricDatum`	`withValue(Double value)` The value for the metric.
`MetricDatum`	`withValues(Collection<Double> values)` Array of numbers representing the values for the metric during the period.
`MetricDatum`	`withValues(Double... values)` Array of numbers representing the values for the metric during the period.

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, 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.
    
    Parameters:
    
    value - 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.
  - getValue
```
public Double getValue()
```
    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.
    
    Returns:
    
    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.
  - withValue
```
public MetricDatum withValue(Double value)
```
    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.
    
    Parameters:
    
    value - 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.
    
    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.
  - getValues
```
public List<Double> getValues()
```
    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.
    
    Returns:
    
    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.
  - setValues
```
public void setValues(Collection<Double> values)
```
    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.
    
    Parameters:
    
    values - 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.
  - withValues
```
public MetricDatum withValues(Double... values)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    values - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValues
```
public MetricDatum withValues(Collection<Double> values)
```
    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.
    
    Parameters:
    
    values - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCounts
```
public List<Double> getCounts()
```
    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.
    
    Returns:
    
    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.
  - setCounts
```
public void setCounts(Collection<Double> counts)
```
    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.
    
    Parameters:
    
    counts - 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.
  - withCounts
```
public MetricDatum withCounts(Double... counts)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCounts(java.util.Collection) or withCounts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    counts - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCounts
```
public MetricDatum withCounts(Collection<Double> counts)
```
    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.
    
    Parameters:
    
    counts - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnit
```
public void setUnit(String unit)
```
    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.
    
    Parameters:
    
    unit - 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.
    
    See Also:
    
    StandardUnit
  - getUnit
```
public String getUnit()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    StandardUnit
  - withUnit
```
public MetricDatum withUnit(String unit)
```
    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.
    
    Parameters:
    
    unit - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandardUnit
  - setUnit
```
public void setUnit(StandardUnit unit)
```
    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.
    
    Parameters:
    
    unit - 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.
    
    See Also:
    
    StandardUnit
  - withUnit
```
public MetricDatum withUnit(StandardUnit unit)
```
    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.
    
    Parameters:
    
    unit - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandardUnit
  - setStorageResolution
```
public void setStorageResolution(Integer storageResolution)
```
    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.
    
    Parameters:
    
    storageResolution - 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.
  - getStorageResolution
```
public Integer getStorageResolution()
```
    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.
    
    Returns:
    
    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.
  - withStorageResolution
```
public MetricDatum withStorageResolution(Integer storageResolution)
```
    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.
    
    Parameters:
    
    storageResolution - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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

Class MetricDatum

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricDatum

Method Detail

setMetricName

getMetricName

withMetricName

getDimensions

setDimensions

withDimensions

withDimensions

setTimestamp

getTimestamp

withTimestamp

setValue

getValue

withValue

setStatisticValues

getStatisticValues

withStatisticValues

getValues

setValues

withValues

withValues

getCounts

setCounts

withCounts

withCounts

setUnit

getUnit

withUnit

setUnit

withUnit

setStorageResolution

getStorageResolution

withStorageResolution

toString

equals

hashCode

clone