/** * 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 Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace CloudWatch { namespace Model { /** *

This structure is used in both GetMetricData and * PutMetricAlarm. The supported use of this structure is different * for those two operations.

When used in GetMetricData, it * indicates the metric data to return, and whether this call is just retrieving a * batch set of data for one metric, or is performing a Metrics Insights query or a * math expression. A single GetMetricData call can include up to 500 * MetricDataQuery structures.

When used in * PutMetricAlarm, it enables you to create an alarm based on a metric * math expression. Each MetricDataQuery in the array specifies either * a metric to retrieve, or a math expression to be performed on retrieved metrics. * A single PutMetricAlarm call can include up to 20 * MetricDataQuery structures in the array. The 20 structures can * include as many as 10 structures that contain a MetricStat * parameter to retrieve a metric, and as many as 10 structures that contain the * Expression parameter to perform a math expression. Of those * Expression structures, one must have true as the value * for ReturnData. The result of this expression is the value the * alarm watches.

Any expression used in a PutMetricAlarm * operation must return a single time series. For more information, see Metric * Math Syntax and Functions in the Amazon CloudWatch User Guide.

Some of the parameters of this structure also have different uses whether you * are using this structure in a GetMetricData operation or a * PutMetricAlarm operation. These differences are explained in the * following parameter list.

*/ class MetricDataQuery { public: AWS_CLOUDWATCH_API MetricDataQuery(); AWS_CLOUDWATCH_API MetricDataQuery(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_CLOUDWATCH_API MetricDataQuery& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_CLOUDWATCH_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_CLOUDWATCH_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

A short name used to tie this object to the results in the response. This * name must be unique within a single call to GetMetricData. If you * are performing math expressions on this set of data, this name represents that * data and can serve as a variable in the mathematical expression. The valid * characters are letters, numbers, and underscore. The first character must be a * lowercase letter.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

*/ inline MetricDataQuery& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

*/ inline MetricDataQuery& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

*/ inline MetricDataQuery& WithId(const char* value) { SetId(value); return *this;} /** *

The metric to be returned, along with statistics, period, and units. Use this * parameter only if this object is retrieving a metric and not performing a math * expression on returned data.

Within one MetricDataQuery object, you must * specify either Expression or MetricStat but not * both.

*/ inline const MetricStat& GetMetricStat() const{ return m_metricStat; } /** *

The metric to be returned, along with statistics, period, and units. Use this * parameter only if this object is retrieving a metric and not performing a math * expression on returned data.

Within one MetricDataQuery object, you must * specify either Expression or MetricStat but not * both.

*/ inline bool MetricStatHasBeenSet() const { return m_metricStatHasBeenSet; } /** *

The metric to be returned, along with statistics, period, and units. Use this * parameter only if this object is retrieving a metric and not performing a math * expression on returned data.

Within one MetricDataQuery object, you must * specify either Expression or MetricStat but not * both.

*/ inline void SetMetricStat(const MetricStat& value) { m_metricStatHasBeenSet = true; m_metricStat = value; } /** *

The metric to be returned, along with statistics, period, and units. Use this * parameter only if this object is retrieving a metric and not performing a math * expression on returned data.

Within one MetricDataQuery object, you must * specify either Expression or MetricStat but not * both.

*/ inline void SetMetricStat(MetricStat&& value) { m_metricStatHasBeenSet = true; m_metricStat = std::move(value); } /** *

The metric to be returned, along with statistics, period, and units. Use this * parameter only if this object is retrieving a metric and not performing a math * expression on returned data.

Within one MetricDataQuery object, you must * specify either Expression or MetricStat but not * both.

*/ inline MetricDataQuery& WithMetricStat(const MetricStat& value) { SetMetricStat(value); return *this;} /** *

The metric to be returned, along with statistics, period, and units. Use this * parameter only if this object is retrieving a metric and not performing a math * expression on returned data.

Within one MetricDataQuery object, you must * specify either Expression or MetricStat but not * both.

*/ inline MetricDataQuery& WithMetricStat(MetricStat&& value) { SetMetricStat(std::move(value)); return *this;} /** *

This field can contain either a Metrics Insights query, or a metric math * expression to be performed on the returned data. For more information about * Metrics Insights queries, see Metrics * Insights query components and syntax in the Amazon CloudWatch User * Guide.

A math expression can use the Id of the other * metrics or queries to refer to those metrics, and can also use the * Id of other expressions to use the result of those expressions. For * more information about metric math expressions, see Metric * Math Syntax and Functions in the Amazon CloudWatch User Guide.

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline const Aws::String& GetExpression() const{ return m_expression; } /** *

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline bool ExpressionHasBeenSet() const { return m_expressionHasBeenSet; } /** *

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline void SetExpression(const Aws::String& value) { m_expressionHasBeenSet = true; m_expression = value; } /** *

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline void SetExpression(Aws::String&& value) { m_expressionHasBeenSet = true; m_expression = std::move(value); } /** *

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline void SetExpression(const char* value) { m_expressionHasBeenSet = true; m_expression.assign(value); } /** *

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline MetricDataQuery& WithExpression(const Aws::String& value) { SetExpression(value); return *this;} /** *

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline MetricDataQuery& WithExpression(Aws::String&& value) { SetExpression(std::move(value)); return *this;} /** *

Within each MetricDataQuery object, you must specify either * Expression or MetricStat but not both.

*/ inline MetricDataQuery& WithExpression(const char* value) { SetExpression(value); return *this;} /** *

A human-readable label for this metric or expression. This is especially * useful if this is an expression, so that you know what the value represents. If * the metric or expression is shown in a CloudWatch dashboard widget, the label is * shown. If Label is omitted, CloudWatch generates a default.

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline const Aws::String& GetLabel() const{ return m_label; } /** *

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline bool LabelHasBeenSet() const { return m_labelHasBeenSet; } /** *

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline void SetLabel(const Aws::String& value) { m_labelHasBeenSet = true; m_label = value; } /** *

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline void SetLabel(Aws::String&& value) { m_labelHasBeenSet = true; m_label = std::move(value); } /** *

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline void SetLabel(const char* value) { m_labelHasBeenSet = true; m_label.assign(value); } /** *

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline MetricDataQuery& WithLabel(const Aws::String& value) { SetLabel(value); return *this;} /** *

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline MetricDataQuery& WithLabel(Aws::String&& value) { SetLabel(std::move(value)); return *this;} /** *

You can put * dynamic expressions into a label, so that it is more descriptive. For more * information, see Using * Dynamic Labels.

*/ inline MetricDataQuery& WithLabel(const char* value) { SetLabel(value); return *this;} /** *

When used in GetMetricData, this option indicates whether to * return the timestamps and raw data values of this metric. If you are performing * this call just to do math expressions and do not also need the raw data * returned, you can specify false. If you omit this, the default of * true is used.

When used in PutMetricAlarm, * specify true for the one expression result to use as the alarm. For * all other metrics and expressions in the same PutMetricAlarm * operation, specify ReturnData as False.

*/ inline bool GetReturnData() const{ return m_returnData; } /** *

*/ inline bool ReturnDataHasBeenSet() const { return m_returnDataHasBeenSet; } /** *

*/ inline void SetReturnData(bool value) { m_returnDataHasBeenSet = true; m_returnData = value; } /** *

*/ inline MetricDataQuery& WithReturnData(bool value) { SetReturnData(value); return *this;} /** *

The granularity, in seconds, of the returned data points. For metrics with * regular resolution, a period can be as short as one minute (60 seconds) and must * be a multiple of 60. For high-resolution metrics that are collected at intervals * of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of * 60. High-resolution metrics are those metrics stored by a * PutMetricData operation that includes a StorageResolution of * 1 second.

*/ inline int GetPeriod() const{ return m_period; } /** *

*/ inline bool PeriodHasBeenSet() const { return m_periodHasBeenSet; } /** *

*/ inline void SetPeriod(int value) { m_periodHasBeenSet = true; m_period = value; } /** *

*/ inline MetricDataQuery& WithPeriod(int value) { SetPeriod(value); return *this;} /** *

The ID of the account where the metrics are located.