@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) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCounts()
For responses, this returns true if the service returned a value for the Counts property.
|
boolean |
hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property.
|
int |
hashCode() |
boolean |
hasValues()
For responses, this returns true if the service returned a value for the Values property.
|
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()
When you are using a
Put operation, this defines what unit you want to use when storing the metric. |
String |
unitAsString()
When you are using a
Put operation, this defines what unit you want to use when storing 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 final String metricName()
The name of the metric.
public final boolean hasDimensions()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Dimension> dimensions()
The dimensions associated with the metric.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDimensions()
method.
public final Instant timestamp()
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
public final 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.
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.
public final StatisticSet statisticValues()
The statistical values for the metric.
public final boolean hasValues()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final 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 -2^360 to 2^360. 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasValues()
method.
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.
public final boolean hasCounts()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCounts()
method.
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 final 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.
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()
.
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.
StandardUnit
public final String unitAsString()
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.
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()
.
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.
StandardUnit
public final 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 final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.