software.amazon.awssdk.services.cloudwatch.model

Class MetricDatum

java.lang.Object

software.amazon.awssdk.services.cloudwatch.model.MetricDatum

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MetricDatum.Builder,MetricDatum>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricDatum.Builder

Method Summary

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() Returns true if the Counts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasDimensions() Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

metricName

public String metricName()

The name of the metric.

Returns:

The name of the metric.

hasDimensions

public boolean hasDimensions()

Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

dimensions

public List<Dimension> dimensions()

The dimensions associated with the metric.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDimensions() to see if a value was sent in this field.

Returns:

The dimensions associated with the metric.

timestamp

public Instant timestamp()

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.

value

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 -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.

statisticValues

public StatisticSet statisticValues()

The statistical values for the metric.

Returns:

The statistical values for the metric.

hasValues

public boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

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 -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.

You can use hasValues() to see if a value was sent in this field.

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.

hasCounts

public boolean hasCounts()

Returns true if the Counts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

counts

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.

You can use hasCounts() to see if a value was sent in this field.

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.

unit

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

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

unitAsString

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

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

storageResolution

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.

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.

toBuilder

public MetricDatum.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricDatum.Builder,MetricDatum>

builder

public static MetricDatum.Builder builder()

serializableBuilderClass

public static Class<? extends MetricDatum.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo