Class Datapoint
- java.lang.Object
-
- software.amazon.awssdk.services.cloudwatch.model.Datapoint
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Datapoint.Builder,Datapoint>
@Generated("software.amazon.awssdk:codegen") public final class Datapoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Datapoint.Builder,Datapoint>
Encapsulates the statistical data that CloudWatch computes from metric data.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Datapoint.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Double
average()
The average of the metric values that correspond to the data point.static Datapoint.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Map<String,Double>
extendedStatistics()
The percentile statistic for the data point.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasExtendedStatistics()
For responses, this returns true if the service returned a value for the ExtendedStatistics property.int
hashCode()
Double
maximum()
The maximum metric value for the data point.Double
minimum()
The minimum metric value for the data point.Double
sampleCount()
The number of metric values that contributed to the aggregate value of this data point.List<SdkField<?>>
sdkFields()
static Class<? extends Datapoint.Builder>
serializableBuilderClass()
Double
sum()
The sum of the metric values for the data point.Instant
timestamp()
The time stamp used for the data point.Datapoint.Builder
toBuilder()
String
toString()
Returns a string representation of this object.StandardUnit
unit()
The standard unit for the data point.String
unitAsString()
The standard unit for the data point.-
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
-
timestamp
public final Instant timestamp()
The time stamp used for the data point.
- Returns:
- The time stamp used for the data point.
-
sampleCount
public final Double sampleCount()
The number of metric values that contributed to the aggregate value of this data point.
- Returns:
- The number of metric values that contributed to the aggregate value of this data point.
-
average
public final Double average()
The average of the metric values that correspond to the data point.
- Returns:
- The average of the metric values that correspond to the data point.
-
sum
public final Double sum()
The sum of the metric values for the data point.
- Returns:
- The sum of the metric values for the data point.
-
minimum
public final Double minimum()
The minimum metric value for the data point.
- Returns:
- The minimum metric value for the data point.
-
maximum
public final Double maximum()
The maximum metric value for the data point.
- Returns:
- The maximum metric value for the data point.
-
unit
public final StandardUnit unit()
The standard unit for the data point.
If the service returns an enum value that is not available in the current SDK version,
unit
will returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The standard unit for the data point.
- See Also:
StandardUnit
-
unitAsString
public final String unitAsString()
The standard unit for the data point.
If the service returns an enum value that is not available in the current SDK version,
unit
will returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The standard unit for the data point.
- See Also:
StandardUnit
-
hasExtendedStatistics
public final boolean hasExtendedStatistics()
For responses, this returns true if the service returned a value for the ExtendedStatistics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
extendedStatistics
public final Map<String,Double> extendedStatistics()
The percentile statistic for the data point.
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
hasExtendedStatistics()
method.- Returns:
- The percentile statistic for the data point.
-
toBuilder
public Datapoint.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Datapoint.Builder,Datapoint>
-
builder
public static Datapoint.Builder builder()
-
serializableBuilderClass
public static Class<? extends Datapoint.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
-