pi/aws.sdk.kotlin.services.pi.model/MetricQuery

MetricQuery

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).

Types

Builder

class Builder

Companion

object Companion

Properties

filter

val filter: Map<String, String>?

One or more filters to apply in the request. Restrictions:

groupBy

val groupBy: DimensionGroup?

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.

metric

val metric: String

The name of a Performance Insights metric to be measured.

Functions

copy

inline fun copy(block: MetricQuery.Builder.() -> Unit = {}): MetricQuery

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String