java.lang.Object
- software.amazon.awssdk.services.pi.model.DimensionKeyDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DimensionKeyDescription.Builder,DimensionKeyDescription>
```
@Generated("software.amazon.awssdk:codegen")
public final class DimensionKeyDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DimensionKeyDescription.Builder,DimensionKeyDescription>
```
An object that includes the requested dimension key values and aggregated metric values within a dimension group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DimensionKeyDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Double>`	`additionalMetrics()`	A map that contains the value for each additional metric.
`static DimensionKeyDescription.Builder`	`builder()`
`Map<String,String>`	`dimensions()`	A map of name-value pairs for the dimensions in the group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalMetrics()`	For responses, this returns true if the service returned a value for the AdditionalMetrics property.
`boolean`	`hasDimensions()`	For responses, this returns true if the service returned a value for the Dimensions property.
`int`	`hashCode()`
`boolean`	`hasPartitions()`	For responses, this returns true if the service returned a value for the Partitions property.
`List<Double>`	`partitions()`	If `PartitionBy` was specified, `PartitionKeys` contains the dimensions that were.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DimensionKeyDescription.Builder>`	`serializableBuilderClass()`
`DimensionKeyDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Double`	`total()`	The aggregated metric value for the dimensions, over the requested time range.

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
  - 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 the 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.
  - dimensions
```
public final Map<String,String> 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
```
public final Double 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 the 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.
  - additionalMetrics
```
public final Map<String,Double> 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 the 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.
  - partitions
```
public final List<Double> 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
```
public DimensionKeyDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DimensionKeyDescription.Builder,DimensionKeyDescription>
  - builder
```
public static DimensionKeyDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DimensionKeyDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DimensionKeyDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasDimensions

dimensions

total

hasAdditionalMetrics

additionalMetrics

hasPartitions

partitions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields