ResponseResourceMetricKey (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResponseResourceMetricKey
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object describing a Performance Insights metric and one or more dimensions for that metric.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ResponseResourceMetricKey()

Constructors
Constructor and Description
`ResponseResourceMetricKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResponseResourceMetricKey`	`addDimensionsEntry(String key, String value)` Add a single Dimensions entry
`ResponseResourceMetricKey`	`clearDimensionsEntries()` Removes all the entries added into Dimensions.
`ResponseResourceMetricKey`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getDimensions()` The valid dimensions for the metric.
`String`	`getMetric()` The name of a Performance Insights metric to be measured.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDimensions(Map<String,String> dimensions)` The valid dimensions for the metric.
`void`	`setMetric(String metric)` The name of a Performance Insights metric to be measured.
`String`	`toString()` Returns a string representation of this object.
`ResponseResourceMetricKey`	`withDimensions(Map<String,String> dimensions)` The valid dimensions for the metric.
`ResponseResourceMetricKey`	`withMetric(String metric)` The name of a Performance Insights metric to be measured.

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

- Constructor Detail
  - ResponseResourceMetricKey
```
public ResponseResourceMetricKey()
```
- Method Detail
  - setMetric
```
public void setMetric(String metric)
```
    The name of a Performance Insights metric to be measured.
    
    Valid values for Metric are:
    - db.load.avg - A scaled representation of the number of active sessions for the database engine.
    - db.sampledload.avg - The raw number of active sessions for the database engine.
    - The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
    - The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
    Parameters:
    metric - The name of a Performance Insights metric to be measured.
    
    Valid values for Metric are:
    
    db.load.avg - A scaled representation of the number of active sessions for the database engine.
    
    db.sampledload.avg - The raw number of active sessions for the database engine.
    
    The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
    
    The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
    
    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
  - getMetric
```
public String getMetric()
```
    The name of a Performance Insights metric to be measured.
    
    Valid values for Metric are:
    - db.load.avg - A scaled representation of the number of active sessions for the database engine.
    - db.sampledload.avg - The raw number of active sessions for the database engine.
    - The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
    - The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
    Returns:
    The name of a Performance Insights metric to be measured.
    
    Valid values for Metric are:
    
    db.load.avg - A scaled representation of the number of active sessions for the database engine.
    
    db.sampledload.avg - The raw number of active sessions for the database engine.
    
    The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
    
    The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
    
    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
  - withMetric
```
public ResponseResourceMetricKey withMetric(String metric)
```
    The name of a Performance Insights metric to be measured.
    
    Valid values for Metric are:
    - db.load.avg - A scaled representation of the number of active sessions for the database engine.
    - db.sampledload.avg - The raw number of active sessions for the database engine.
    - The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
    - The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
    Parameters:
    metric - The name of a Performance Insights metric to be measured.
    
    Valid values for Metric are:
    
    db.load.avg - A scaled representation of the number of active sessions for the database engine.
    
    db.sampledload.avg - The raw number of active sessions for the database engine.
    
    The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
    
    The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
    
    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDimensions
```
public Map<String,String> getDimensions()
```
    The valid dimensions for the metric.
    
    Returns:
    
    The valid dimensions for the metric.
  - setDimensions
```
public void setDimensions(Map<String,String> dimensions)
```
    The valid dimensions for the metric.
    
    Parameters:
    
    dimensions - The valid dimensions for the metric.
  - withDimensions
```
public ResponseResourceMetricKey withDimensions(Map<String,String> dimensions)
```
    The valid dimensions for the metric.
    
    Parameters:
    
    dimensions - The valid dimensions for the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDimensionsEntry
```
public ResponseResourceMetricKey addDimensionsEntry(String key,
                                                    String value)
```
    Add a single Dimensions entry
    
    See Also:
    
    withDimensions(java.util.Map<java.lang.String, java.lang.String>)
  - clearDimensionsEntries
```
public ResponseResourceMetricKey clearDimensionsEntries()
```
    Removes all the entries added into Dimensions.
    
    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 ResponseResourceMetricKey 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 ResponseResourceMetricKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResponseResourceMetricKey

Method Detail

setMetric

getMetric

withMetric

getDimensions

setDimensions

withDimensions

addDimensionsEntry

clearDimensionsEntries

toString

equals

hashCode

clone

marshall