DimensionKeyDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pi.model.DimensionKeyDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DimensionKeyDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that includes the requested dimension key values and aggregated metric values within a dimension group.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DimensionKeyDescription()

Constructors
Constructor and Description
`DimensionKeyDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DimensionKeyDescription`	`addAdditionalMetricsEntry(String key, Double value)` Add a single AdditionalMetrics entry
`DimensionKeyDescription`	`addDimensionsEntry(String key, String value)` Add a single Dimensions entry
`DimensionKeyDescription`	`clearAdditionalMetricsEntries()` Removes all the entries added into AdditionalMetrics.
`DimensionKeyDescription`	`clearDimensionsEntries()` Removes all the entries added into Dimensions.
`DimensionKeyDescription`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,Double>`	`getAdditionalMetrics()` A map that contains the value for each additional metric.
`Map<String,String>`	`getDimensions()` A map of name-value pairs for the dimensions in the group.
`List<Double>`	`getPartitions()` If `PartitionBy` was specified, `PartitionKeys` contains the dimensions that were.
`Double`	`getTotal()` The aggregated metric value for the dimensions, over the requested time range.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalMetrics(Map<String,Double> additionalMetrics)` A map that contains the value for each additional metric.
`void`	`setDimensions(Map<String,String> dimensions)` A map of name-value pairs for the dimensions in the group.
`void`	`setPartitions(Collection<Double> partitions)` If `PartitionBy` was specified, `PartitionKeys` contains the dimensions that were.
`void`	`setTotal(Double total)` The aggregated metric value for the dimensions, over the requested time range.
`String`	`toString()` Returns a string representation of this object.
`DimensionKeyDescription`	`withAdditionalMetrics(Map<String,Double> additionalMetrics)` A map that contains the value for each additional metric.
`DimensionKeyDescription`	`withDimensions(Map<String,String> dimensions)` A map of name-value pairs for the dimensions in the group.
`DimensionKeyDescription`	`withPartitions(Collection<Double> partitions)` If `PartitionBy` was specified, `PartitionKeys` contains the dimensions that were.
`DimensionKeyDescription`	`withPartitions(Double... partitions)` If `PartitionBy` was specified, `PartitionKeys` contains the dimensions that were.
`DimensionKeyDescription`	`withTotal(Double total)` The aggregated metric value for the dimensions, over the requested time range.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DimensionKeyDescription
```
public DimensionKeyDescription()
```
- Method Detail
  - getDimensions
```
public Map<String,String> getDimensions()
```
    A map of name-value pairs for the dimensions in the group.
    
    Returns:
    
    A map of name-value pairs for the dimensions in the group.
  - setDimensions
```
public void setDimensions(Map<String,String> dimensions)
```
    A map of name-value pairs for the dimensions in the group.
    
    Parameters:
    
    dimensions - A map of name-value pairs for the dimensions in the group.
  - withDimensions
```
public DimensionKeyDescription withDimensions(Map<String,String> dimensions)
```
    A map of name-value pairs for the dimensions in the group.
    
    Parameters:
    
    dimensions - A map of name-value pairs for the dimensions in the group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDimensionsEntry
```
public DimensionKeyDescription addDimensionsEntry(String key,
                                                  String value)
```
    Add a single Dimensions entry
    
    See Also:
    
    withDimensions(java.util.Map<java.lang.String, java.lang.String>)
  - clearDimensionsEntries
```
public DimensionKeyDescription clearDimensionsEntries()
```
    Removes all the entries added into Dimensions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotal
```
public void setTotal(Double total)
```
    The aggregated metric value for the dimensions, over the requested time range.
    
    Parameters:
    
    total - The aggregated metric value for the dimensions, over the requested time range.
  - getTotal
```
public Double getTotal()
```
    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.
  - withTotal
```
public DimensionKeyDescription withTotal(Double total)
```
    The aggregated metric value for the dimensions, over the requested time range.
    
    Parameters:
    
    total - The aggregated metric value for the dimensions, over the requested time range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalMetrics
```
public Map<String,Double> getAdditionalMetrics()
```
    A map that contains the value for each additional metric.
    
    Returns:
    
    A map that contains the value for each additional metric.
  - setAdditionalMetrics
```
public void setAdditionalMetrics(Map<String,Double> additionalMetrics)
```
    A map that contains the value for each additional metric.
    
    Parameters:
    
    additionalMetrics - A map that contains the value for each additional metric.
  - withAdditionalMetrics
```
public DimensionKeyDescription withAdditionalMetrics(Map<String,Double> additionalMetrics)
```
    A map that contains the value for each additional metric.
    
    Parameters:
    
    additionalMetrics - A map that contains the value for each additional metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAdditionalMetricsEntry
```
public DimensionKeyDescription addAdditionalMetricsEntry(String key,
                                                         Double value)
```
    Add a single AdditionalMetrics entry
    
    See Also:
    
    withAdditionalMetrics(java.util.Map<java.lang.String, java.lang.Double>)
  - clearAdditionalMetricsEntries
```
public DimensionKeyDescription clearAdditionalMetricsEntries()
```
    Removes all the entries added into AdditionalMetrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPartitions
```
public List<Double> getPartitions()
```
    If PartitionBy was specified, PartitionKeys contains the dimensions that were.
    
    Returns:
    
    If PartitionBy was specified, PartitionKeys contains the dimensions that were.
  - setPartitions
```
public void setPartitions(Collection<Double> partitions)
```
    If PartitionBy was specified, PartitionKeys contains the dimensions that were.
    
    Parameters:
    
    partitions - If PartitionBy was specified, PartitionKeys contains the dimensions that were.
  - withPartitions
```
public DimensionKeyDescription withPartitions(Double... partitions)
```
    If PartitionBy was specified, PartitionKeys contains the dimensions that were.
    
    NOTE: This method appends the values to the existing list (if any). Use setPartitions(java.util.Collection) or withPartitions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    partitions - If PartitionBy was specified, PartitionKeys contains the dimensions that were.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPartitions
```
public DimensionKeyDescription withPartitions(Collection<Double> partitions)
```
    If PartitionBy was specified, PartitionKeys contains the dimensions that were.
    
    Parameters:
    
    partitions - If PartitionBy was specified, PartitionKeys contains the dimensions that were.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DimensionKeyDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class DimensionKeyDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DimensionKeyDescription

Method Detail

getDimensions

setDimensions

withDimensions

addDimensionsEntry

clearDimensionsEntries

setTotal

getTotal

withTotal

getAdditionalMetrics

setAdditionalMetrics

withAdditionalMetrics

addAdditionalMetricsEntry

clearAdditionalMetricsEntries

getPartitions

setPartitions

withPartitions

withPartitions

toString

equals

hashCode

clone

marshall