@Generated(value="software.amazon.awssdk:codegen") public final class MetricDatum extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricDatum.Builder,MetricDatum>
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
Modifier and Type | Class and Description |
---|---|
static interface |
MetricDatum.Builder |
Modifier and Type | Method and Description |
---|---|
static MetricDatum.Builder |
builder() |
List<Double> |
counts()
Array of numbers that is used along with the
Values array. |
List<Dimension> |
dimensions()
The dimensions associated with the metric.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
metricName()
The name of the metric.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends MetricDatum.Builder> |
serializableBuilderClass() |
StatisticSet |
statisticValues()
The statistical values for the metric.
|
Integer |
storageResolution()
Valid values are 1 and 60.
|
Instant |
timestamp()
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
|
MetricDatum.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
StandardUnit |
unit()
The unit of the metric.
|
String |
unitAsString()
The unit of the metric.
|
Double |
value()
The value for the metric.
|
List<Double> |
values()
Array of numbers representing the values for the metric during the period.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String metricName()
The name of the metric.
public List<Dimension> dimensions()
The dimensions associated with the metric.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Instant timestamp()
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
public 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 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.
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 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.
public StatisticSet statisticValues()
The statistical values for the metric.
public List<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 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 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.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public StandardUnit unit()
The unit of the metric.
If the service returns an enum value that is not available in the current SDK version, unit
will return
StandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
StandardUnit
public String unitAsString()
The unit of the metric.
If the service returns an enum value that is not available in the current SDK version, unit
will return
StandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
StandardUnit
public 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.
This field is optional, if you do not specify it the default of 60 is used.
public MetricDatum.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MetricDatum.Builder,MetricDatum>
public static MetricDatum.Builder builder()
public static Class<? extends MetricDatum.Builder> serializableBuilderClass()
public String toString()
Copyright © 2019. All rights reserved.