Class DimensionKeyDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DimensionKeyDescription.Builder,
DimensionKeyDescription>
An object that includes the requested dimension key values and aggregated metric values within a dimension group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA map that contains the value for each additional metric.builder()
A map of name-value pairs for the dimensions in the group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 AdditionalMetrics property.final boolean
For responses, this returns true if the service returned a value for the Dimensions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Partitions property.IfPartitionBy
was specified,PartitionKeys
contains the dimensions that were.static Class
<? extends DimensionKeyDescription.Builder> 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 Double
total()
The aggregated metric value for the dimensions, over the requested time range.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasDimensions
public final boolean hasDimensions()For responses, this returns true if the service returned a value for the Dimensions 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. -
dimensions
A map of name-value pairs for the dimensions in the group.
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.- Returns:
- A map of name-value pairs for the dimensions in the group.
-
total
The aggregated metric value for the dimensions, over the requested time range.
- Returns:
- The aggregated metric value for the dimensions, over the requested time range.
-
hasAdditionalMetrics
public final boolean hasAdditionalMetrics()For responses, this returns true if the service returned a value for the AdditionalMetrics 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. -
additionalMetrics
A map that contains the value for each additional 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
hasAdditionalMetrics()
method.- Returns:
- A map that contains the value for each additional metric.
-
hasPartitions
public final boolean hasPartitions()For responses, this returns true if the service returned a value for the Partitions 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. -
partitions
If
PartitionBy
was specified,PartitionKeys
contains the dimensions that were.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
hasPartitions()
method.- Returns:
- If
PartitionBy
was specified,PartitionKeys
contains the dimensions that were.
-
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<DimensionKeyDescription.Builder,
DimensionKeyDescription> - 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
-