PerformanceInsightsMetricQuery (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.devopsguru.model.PerformanceInsightsMetricQuery

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PerformanceInsightsMetricQuery
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
- To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
- To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PerformanceInsightsMetricQuery()

Constructors
Constructor and Description
`PerformanceInsightsMetricQuery()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PerformanceInsightsMetricQuery`	`addFilterEntry(String key, String value)` Add a single Filter entry
`PerformanceInsightsMetricQuery`	`clearFilterEntries()` Removes all the entries added into Filter.
`PerformanceInsightsMetricQuery`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getFilter()` One or more filters to apply to a Performance Insights `GetResourceMetrics` API query.
`PerformanceInsightsMetricDimensionGroup`	`getGroupBy()` The specification for how to aggregate the data points from a Performance Insights `GetResourceMetrics` API query.
`String`	`getMetric()` The name of the meteric used used when querying an Performance Insights `GetResourceMetrics` API for anomaly metrics.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFilter(Map<String,String> filter)` One or more filters to apply to a Performance Insights `GetResourceMetrics` API query.
`void`	`setGroupBy(PerformanceInsightsMetricDimensionGroup groupBy)` The specification for how to aggregate the data points from a Performance Insights `GetResourceMetrics` API query.
`void`	`setMetric(String metric)` The name of the meteric used used when querying an Performance Insights `GetResourceMetrics` API for anomaly metrics.
`String`	`toString()` Returns a string representation of this object.
`PerformanceInsightsMetricQuery`	`withFilter(Map<String,String> filter)` One or more filters to apply to a Performance Insights `GetResourceMetrics` API query.
`PerformanceInsightsMetricQuery`	`withGroupBy(PerformanceInsightsMetricDimensionGroup groupBy)` The specification for how to aggregate the data points from a Performance Insights `GetResourceMetrics` API query.
`PerformanceInsightsMetricQuery`	`withMetric(String metric)` The name of the meteric used used when querying an Performance Insights `GetResourceMetrics` API for anomaly metrics.

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

- Constructor Detail
  - PerformanceInsightsMetricQuery
```
public PerformanceInsightsMetricQuery()
```
- Method Detail
  - setMetric
```
public void setMetric(String metric)
```
    The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
    
    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.
    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 the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
    
    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.
    
    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 the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
    
    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.
    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 the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
    
    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.
    
    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 PerformanceInsightsMetricQuery withMetric(String metric)
```
    The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
    
    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.
    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 the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
    
    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.
    
    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.
  - setGroupBy
```
public void setGroupBy(PerformanceInsightsMetricDimensionGroup groupBy)
```
    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
    
    Parameters:
    
    groupBy - The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
  - getGroupBy
```
public PerformanceInsightsMetricDimensionGroup getGroupBy()
```
    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
    
    Returns:
    
    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
  - withGroupBy
```
public PerformanceInsightsMetricQuery withGroupBy(PerformanceInsightsMetricDimensionGroup groupBy)
```
    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
    
    Parameters:
    
    groupBy - The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilter
```
public Map<String,String> getFilter()
```
    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
    - Any number of filters by the same dimension, as specified in the GroupBy parameter.
    - A single filter for any other dimension in this dimension group.
    Returns:
    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
    
    Any number of filters by the same dimension, as specified in the GroupBy parameter.
    
    A single filter for any other dimension in this dimension group.
  - setFilter
```
public void setFilter(Map<String,String> filter)
```
    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
    - Any number of filters by the same dimension, as specified in the GroupBy parameter.
    - A single filter for any other dimension in this dimension group.
    Parameters:
    filter - One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
    
    Any number of filters by the same dimension, as specified in the GroupBy parameter.
    
    A single filter for any other dimension in this dimension group.
  - withFilter
```
public PerformanceInsightsMetricQuery withFilter(Map<String,String> filter)
```
    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
    - Any number of filters by the same dimension, as specified in the GroupBy parameter.
    - A single filter for any other dimension in this dimension group.
    Parameters:
    filter - One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
    
    Any number of filters by the same dimension, as specified in the GroupBy parameter.
    
    A single filter for any other dimension in this dimension group.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addFilterEntry
```
public PerformanceInsightsMetricQuery addFilterEntry(String key,
                                                     String value)
```
    Add a single Filter entry
    
    See Also:
    
    withFilter(java.util.Map<java.lang.String, java.lang.String>)
  - clearFilterEntries
```
public PerformanceInsightsMetricQuery clearFilterEntries()
```
    Removes all the entries added into Filter.
    
    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 PerformanceInsightsMetricQuery 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.

Did this page help you?

Class PerformanceInsightsMetricQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PerformanceInsightsMetricQuery

Method Detail

setMetric

getMetric

withMetric

setGroupBy

getGroupBy

withGroupBy

getFilter

setFilter

withFilter

addFilterEntry

clearFilterEntries

toString

equals

hashCode

clone

marshall