com.amazonaws.services.pi.model

Class DimensionKeyDescription

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 array of descriptions and aggregated values for each dimension within a dimension group.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DimensionKeyDescription()

Method Summary

Modifier and Type	Method and Description
DimensionKeyDescription	addDimensionsEntry(String key, String value) Add a single Dimensions entry
DimensionKeyDescription	clearDimensionsEntries() Removes all the entries added into Dimensions.
DimensionKeyDescription	clone()
boolean	equals(Object obj)
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 dimension(s), over the requested time range.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
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 dimension(s), over the requested time range.
String	toString() Returns a string representation of this object.
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 dimension(s), over the requested time range.

Methods inherited from class java.lang.Object

finalize, 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 dimension(s), over the requested time range.

Parameters:

total - The aggregated metric value for the dimension(s), over the requested time range.

getTotal

public Double getTotal()

The aggregated metric value for the dimension(s), over the requested time range.

Returns:

The aggregated metric value for the dimension(s), over the requested time range.

withTotal

public DimensionKeyDescription withTotal(Double total)

The aggregated metric value for the dimension(s), over the requested time range.

Parameters:

total - The aggregated metric value for the dimension(s), over the requested time range.

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)

Specified by:

marshall in interface StructuredPojo