/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace PI { namespace Model { /** *

A single query to be processed. You must provide the metric to query. If no * other parameters are specified, Performance Insights returns all of the data * points for that metric. You can optionally 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 * Reference

*/ class AWS_PI_API MetricQuery { public: MetricQuery(); MetricQuery(Aws::Utils::Json::JsonView jsonValue); MetricQuery& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline const Aws::String& GetMetric() const{ return m_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.

*/ inline bool MetricHasBeenSet() const { return m_metricHasBeenSet; } /** *

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.

*/ inline void SetMetric(const Aws::String& value) { m_metricHasBeenSet = true; m_metric = value; } /** *

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.

*/ inline void SetMetric(Aws::String&& value) { m_metricHasBeenSet = true; m_metric = std::move(value); } /** *

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.

*/ inline void SetMetric(const char* value) { m_metricHasBeenSet = true; m_metric.assign(value); } /** *

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.

*/ inline MetricQuery& WithMetric(const Aws::String& value) { SetMetric(value); return *this;} /** *

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.

*/ inline MetricQuery& WithMetric(Aws::String&& value) { SetMetric(std::move(value)); return *this;} /** *

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.

*/ inline MetricQuery& WithMetric(const char* value) { SetMetric(value); return *this;} /** *

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.

*/ inline const DimensionGroup& GetGroupBy() const{ return m_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.

*/ inline bool GroupByHasBeenSet() const { return m_groupByHasBeenSet; } /** *

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.

*/ inline void SetGroupBy(const DimensionGroup& value) { m_groupByHasBeenSet = true; m_groupBy = value; } /** *

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.

*/ inline void SetGroupBy(DimensionGroup&& value) { m_groupByHasBeenSet = true; m_groupBy = std::move(value); } /** *

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.

*/ inline MetricQuery& WithGroupBy(const DimensionGroup& value) { SetGroupBy(value); return *this;} /** *

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.

*/ inline MetricQuery& WithGroupBy(DimensionGroup&& value) { SetGroupBy(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Map& GetFilter() const{ return m_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.

*/ inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; } /** *

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.

*/ inline void SetFilter(const Aws::Map& value) { m_filterHasBeenSet = true; m_filter = value; } /** *

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.

*/ inline void SetFilter(Aws::Map&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); } /** *

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.

*/ inline MetricQuery& WithFilter(const Aws::Map& value) { SetFilter(value); return *this;} /** *

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.

*/ inline MetricQuery& WithFilter(Aws::Map&& value) { SetFilter(std::move(value)); return *this;} /** *

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.

*/ inline MetricQuery& AddFilter(const Aws::String& key, const Aws::String& value) { m_filterHasBeenSet = true; m_filter.emplace(key, value); return *this; } /** *

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.

*/ inline MetricQuery& AddFilter(Aws::String&& key, const Aws::String& value) { m_filterHasBeenSet = true; m_filter.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline MetricQuery& AddFilter(const Aws::String& key, Aws::String&& value) { m_filterHasBeenSet = true; m_filter.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline MetricQuery& AddFilter(Aws::String&& key, Aws::String&& value) { m_filterHasBeenSet = true; m_filter.emplace(std::move(key), std::move(value)); return *this; } /** *

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.

*/ inline MetricQuery& AddFilter(const char* key, Aws::String&& value) { m_filterHasBeenSet = true; m_filter.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline MetricQuery& AddFilter(Aws::String&& key, const char* value) { m_filterHasBeenSet = true; m_filter.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline MetricQuery& AddFilter(const char* key, const char* value) { m_filterHasBeenSet = true; m_filter.emplace(key, value); return *this; } private: Aws::String m_metric; bool m_metricHasBeenSet; DimensionGroup m_groupBy; bool m_groupByHasBeenSet; Aws::Map m_filter; bool m_filterHasBeenSet; }; } // namespace Model } // namespace PI } // namespace Aws