MetricQuery (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricQuery
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A single query to be processed. You must provide the metric to query and append an aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum . If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return only those data points that match your criteria (Filter).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetricQuery()

Constructors
Constructor and Description
`MetricQuery()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricQuery`	`addFilterEntry(String key, String value)` Add a single Filter entry
`MetricQuery`	`clearFilterEntries()` Removes all the entries added into Filter.
`MetricQuery`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getFilter()` One or more filters to apply in the request.
`DimensionGroup`	`getGroupBy()` A specification for how to aggregate the data points from a query result.
`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`	`setFilter(Map<String,String> filter)` One or more filters to apply in the request.
`void`	`setGroupBy(DimensionGroup groupBy)` A specification for how to aggregate the data points from a query result.
`void`	`setMetric(String metric)` The name of a Performance Insights metric to be measured.
`String`	`toString()` Returns a string representation of this object.
`MetricQuery`	`withFilter(Map<String,String> filter)` One or more filters to apply in the request.
`MetricQuery`	`withGroupBy(DimensionGroup groupBy)` A specification for how to aggregate the data points from a query result.
`MetricQuery`	`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
  - MetricQuery
```
public MetricQuery()
```
- 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 MetricQuery 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.
  - setGroupBy
```
public void setGroupBy(DimensionGroup groupBy)
```
    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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 - A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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 DimensionGroup getGroupBy()
```
    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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:
    
    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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 MetricQuery withGroupBy(DimensionGroup groupBy)
```
    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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 - A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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 in the request. 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.
    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
    Returns:
    One or more filters to apply in the request. 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.
    
    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
  - setFilter
```
public void setFilter(Map<String,String> filter)
```
    One or more filters to apply in the request. 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.
    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
    Parameters:
    filter - One or more filters to apply in the request. 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.
    
    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
  - withFilter
```
public MetricQuery withFilter(Map<String,String> filter)
```
    One or more filters to apply in the request. 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.
    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
    Parameters:
    filter - One or more filters to apply in the request. 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.
    
    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addFilterEntry
```
public MetricQuery addFilterEntry(String key,
                                  String value)
```
    Add a single Filter entry
    
    See Also:
    
    withFilter(java.util.Map<java.lang.String, java.lang.String>)
  - clearFilterEntries
```
public MetricQuery 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 MetricQuery 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.793

Class MetricQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricQuery

Method Detail

setMetric

getMetric

withMetric

setGroupBy

getGroupBy

withGroupBy

getFilter

setFilter

withFilter

addFilterEntry

clearFilterEntries

toString

equals

hashCode

clone

marshall