Class Datapoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Datapoint.Builder,
Datapoint>
Encapsulates the statistical data that CloudWatch computes from metric data.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Double
average()
The average of the metric values that correspond to the data point.static Datapoint.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The percentile statistic for the data point.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExtendedStatistics property.final int
hashCode()
final Double
maximum()
The maximum metric value for the data point.final Double
minimum()
The minimum metric value for the data point.final Double
The number of metric values that contributed to the aggregate value of this data point.static Class
<? extends Datapoint.Builder> final Double
sum()
The sum of the metric values for the data point.final Instant
The time stamp used for the data point.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final StandardUnit
unit()
The standard unit for the data point.final String
The standard unit for the data point.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
timestamp
The time stamp used for the data point.
- Returns:
- The time stamp used for the data point.
-
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
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
The sum of the metric values for the data point.
- Returns:
- The sum of the metric values for the data point.
-
minimum
The minimum metric value for the data point.
- Returns:
- The minimum metric value for the data point.
-
maximum
The maximum metric value for the data point.
- Returns:
- The maximum metric value for the data point.
-
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:
-
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:
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Datapoint.Builder,
Datapoint> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-