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

Encapsulates the information sent to either create a metric or add new values * to be aggregated into an existing metric.

See Also:

AWS * API Reference

*/ class MetricDatum { public: AWS_CLOUDWATCH_API MetricDatum(); AWS_CLOUDWATCH_API MetricDatum(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_CLOUDWATCH_API MetricDatum& 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; /** *

The name of the metric.

*/ inline const Aws::String& GetMetricName() const{ return m_metricName; } /** *

The name of the metric.

*/ inline bool MetricNameHasBeenSet() const { return m_metricNameHasBeenSet; } /** *

The name of the metric.

*/ inline void SetMetricName(const Aws::String& value) { m_metricNameHasBeenSet = true; m_metricName = value; } /** *

The name of the metric.

*/ inline void SetMetricName(Aws::String&& value) { m_metricNameHasBeenSet = true; m_metricName = std::move(value); } /** *

The name of the metric.

*/ inline void SetMetricName(const char* value) { m_metricNameHasBeenSet = true; m_metricName.assign(value); } /** *

The name of the metric.

*/ inline MetricDatum& WithMetricName(const Aws::String& value) { SetMetricName(value); return *this;} /** *

The name of the metric.

*/ inline MetricDatum& WithMetricName(Aws::String&& value) { SetMetricName(std::move(value)); return *this;} /** *

The name of the metric.

*/ inline MetricDatum& WithMetricName(const char* value) { SetMetricName(value); return *this;} /** *

The dimensions associated with the metric.

*/ inline const Aws::Vector& GetDimensions() const{ return m_dimensions; } /** *

The dimensions associated with the metric.

*/ inline bool DimensionsHasBeenSet() const { return m_dimensionsHasBeenSet; } /** *

The dimensions associated with the metric.

*/ inline void SetDimensions(const Aws::Vector& value) { m_dimensionsHasBeenSet = true; m_dimensions = value; } /** *

The dimensions associated with the metric.

*/ inline void SetDimensions(Aws::Vector&& value) { m_dimensionsHasBeenSet = true; m_dimensions = std::move(value); } /** *

The dimensions associated with the metric.

*/ inline MetricDatum& WithDimensions(const Aws::Vector& value) { SetDimensions(value); return *this;} /** *

The dimensions associated with the metric.

*/ inline MetricDatum& WithDimensions(Aws::Vector&& value) { SetDimensions(std::move(value)); return *this;} /** *

The dimensions associated with the metric.

*/ inline MetricDatum& AddDimensions(const Dimension& value) { m_dimensionsHasBeenSet = true; m_dimensions.push_back(value); return *this; } /** *

The dimensions associated with the metric.

*/ inline MetricDatum& AddDimensions(Dimension&& value) { m_dimensionsHasBeenSet = true; m_dimensions.push_back(std::move(value)); return *this; } /** *

The time the metric data was received, expressed as the number of * milliseconds since Jan 1, 1970 00:00:00 UTC.

*/ inline const Aws::Utils::DateTime& GetTimestamp() const{ return m_timestamp; } /** *

The time the metric data was received, expressed as the number of * milliseconds since Jan 1, 1970 00:00:00 UTC.

*/ inline bool TimestampHasBeenSet() const { return m_timestampHasBeenSet; } /** *

The time the metric data was received, expressed as the number of * milliseconds since Jan 1, 1970 00:00:00 UTC.

*/ inline void SetTimestamp(const Aws::Utils::DateTime& value) { m_timestampHasBeenSet = true; m_timestamp = value; } /** *

The time the metric data was received, expressed as the number of * milliseconds since Jan 1, 1970 00:00:00 UTC.

*/ inline void SetTimestamp(Aws::Utils::DateTime&& value) { m_timestampHasBeenSet = true; m_timestamp = std::move(value); } /** *

The time the metric data was received, expressed as the number of * milliseconds since Jan 1, 1970 00:00:00 UTC.

*/ inline MetricDatum& WithTimestamp(const Aws::Utils::DateTime& value) { SetTimestamp(value); return *this;} /** *

The time the metric data was received, expressed as the number of * milliseconds since Jan 1, 1970 00:00:00 UTC.

*/ inline MetricDatum& WithTimestamp(Aws::Utils::DateTime&& value) { SetTimestamp(std::move(value)); return *this;} /** *

The value for the metric.

Although the parameter accepts numbers of * type Double, CloudWatch rejects values that are either too small or too large. * Values must be in the range of -2^360 to 2^360. In addition, special values (for * example, NaN, +Infinity, -Infinity) are not supported.

*/ inline double GetValue() const{ return m_value; } /** *

The value for the metric.

Although the parameter accepts numbers of * type Double, CloudWatch rejects values that are either too small or too large. * Values must be in the range of -2^360 to 2^360. In addition, special values (for * example, NaN, +Infinity, -Infinity) are not supported.

*/ inline bool ValueHasBeenSet() const { return m_valueHasBeenSet; } /** *

The value for the metric.

Although the parameter accepts numbers of * type Double, CloudWatch rejects values that are either too small or too large. * Values must be in the range of -2^360 to 2^360. In addition, special values (for * example, NaN, +Infinity, -Infinity) are not supported.

*/ inline void SetValue(double value) { m_valueHasBeenSet = true; m_value = value; } /** *

The value for the metric.

Although the parameter accepts numbers of * type Double, CloudWatch rejects values that are either too small or too large. * Values must be in the range of -2^360 to 2^360. In addition, special values (for * example, NaN, +Infinity, -Infinity) are not supported.

*/ inline MetricDatum& WithValue(double value) { SetValue(value); return *this;} /** *

The statistical values for the metric.

*/ inline const StatisticSet& GetStatisticValues() const{ return m_statisticValues; } /** *

The statistical values for the metric.

*/ inline bool StatisticValuesHasBeenSet() const { return m_statisticValuesHasBeenSet; } /** *

The statistical values for the metric.

*/ inline void SetStatisticValues(const StatisticSet& value) { m_statisticValuesHasBeenSet = true; m_statisticValues = value; } /** *

The statistical values for the metric.

*/ inline void SetStatisticValues(StatisticSet&& value) { m_statisticValuesHasBeenSet = true; m_statisticValues = std::move(value); } /** *

The statistical values for the metric.

*/ inline MetricDatum& WithStatisticValues(const StatisticSet& value) { SetStatisticValues(value); return *this;} /** *

The statistical values for the metric.

*/ inline MetricDatum& WithStatisticValues(StatisticSet&& value) { SetStatisticValues(std::move(value)); return *this;} /** *

Array of numbers representing the values for the metric during the period. * Each unique value is listed just once in this array, and the corresponding * number in the Counts array specifies the number of times that value * occurred during the period. You can include up to 150 unique values in each * PutMetricData action that specifies a Values * array.

Although the Values array accepts numbers of type * Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special * values (for example, NaN, +Infinity, -Infinity) are not supported.

*/ inline const Aws::Vector& GetValues() const{ return m_values; } /** *

Array of numbers representing the values for the metric during the period. * Each unique value is listed just once in this array, and the corresponding * number in the Counts array specifies the number of times that value * occurred during the period. You can include up to 150 unique values in each * PutMetricData action that specifies a Values * array.

Although the Values array accepts numbers of type * Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special * values (for example, NaN, +Infinity, -Infinity) are not supported.

*/ inline bool ValuesHasBeenSet() const { return m_valuesHasBeenSet; } /** *

Array of numbers representing the values for the metric during the period. * Each unique value is listed just once in this array, and the corresponding * number in the Counts array specifies the number of times that value * occurred during the period. You can include up to 150 unique values in each * PutMetricData action that specifies a Values * array.

Although the Values array accepts numbers of type * Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special * values (for example, NaN, +Infinity, -Infinity) are not supported.

*/ inline void SetValues(const Aws::Vector& value) { m_valuesHasBeenSet = true; m_values = value; } /** *

Array of numbers representing the values for the metric during the period. * Each unique value is listed just once in this array, and the corresponding * number in the Counts array specifies the number of times that value * occurred during the period. You can include up to 150 unique values in each * PutMetricData action that specifies a Values * array.

Although the Values array accepts numbers of type * Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special * values (for example, NaN, +Infinity, -Infinity) are not supported.

*/ inline void SetValues(Aws::Vector&& value) { m_valuesHasBeenSet = true; m_values = std::move(value); } /** *

Array of numbers representing the values for the metric during the period. * Each unique value is listed just once in this array, and the corresponding * number in the Counts array specifies the number of times that value * occurred during the period. You can include up to 150 unique values in each * PutMetricData action that specifies a Values * array.

Although the Values array accepts numbers of type * Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special * values (for example, NaN, +Infinity, -Infinity) are not supported.

*/ inline MetricDatum& WithValues(const Aws::Vector& value) { SetValues(value); return *this;} /** *

Array of numbers representing the values for the metric during the period. * Each unique value is listed just once in this array, and the corresponding * number in the Counts array specifies the number of times that value * occurred during the period. You can include up to 150 unique values in each * PutMetricData action that specifies a Values * array.

Although the Values array accepts numbers of type * Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special * values (for example, NaN, +Infinity, -Infinity) are not supported.

*/ inline MetricDatum& WithValues(Aws::Vector&& value) { SetValues(std::move(value)); return *this;} /** *

Array of numbers representing the values for the metric during the period. * Each unique value is listed just once in this array, and the corresponding * number in the Counts array specifies the number of times that value * occurred during the period. You can include up to 150 unique values in each * PutMetricData action that specifies a Values * array.

Although the Values array accepts numbers of type * Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special * values (for example, NaN, +Infinity, -Infinity) are not supported.

*/ inline MetricDatum& AddValues(double value) { m_valuesHasBeenSet = true; m_values.push_back(value); return *this; } /** *

Array of numbers that is used along with the Values array. Each * number in the Count array is the number of times the corresponding * value in the Values array occurred during the period.

If * you omit the Counts array, the default of 1 is used as the value * for each count. If you include a Counts array, it must include the * same amount of values as the Values array.

*/ inline const Aws::Vector& GetCounts() const{ return m_counts; } /** *

Array of numbers that is used along with the Values array. Each * number in the Count array is the number of times the corresponding * value in the Values array occurred during the period.

If * you omit the Counts array, the default of 1 is used as the value * for each count. If you include a Counts array, it must include the * same amount of values as the Values array.

*/ inline bool CountsHasBeenSet() const { return m_countsHasBeenSet; } /** *

Array of numbers that is used along with the Values array. Each * number in the Count array is the number of times the corresponding * value in the Values array occurred during the period.

If * you omit the Counts array, the default of 1 is used as the value * for each count. If you include a Counts array, it must include the * same amount of values as the Values array.

*/ inline void SetCounts(const Aws::Vector& value) { m_countsHasBeenSet = true; m_counts = value; } /** *

Array of numbers that is used along with the Values array. Each * number in the Count array is the number of times the corresponding * value in the Values array occurred during the period.

If * you omit the Counts array, the default of 1 is used as the value * for each count. If you include a Counts array, it must include the * same amount of values as the Values array.

*/ inline void SetCounts(Aws::Vector&& value) { m_countsHasBeenSet = true; m_counts = std::move(value); } /** *

Array of numbers that is used along with the Values array. Each * number in the Count array is the number of times the corresponding * value in the Values array occurred during the period.

If * you omit the Counts array, the default of 1 is used as the value * for each count. If you include a Counts array, it must include the * same amount of values as the Values array.

*/ inline MetricDatum& WithCounts(const Aws::Vector& value) { SetCounts(value); return *this;} /** *

Array of numbers that is used along with the Values array. Each * number in the Count array is the number of times the corresponding * value in the Values array occurred during the period.

If * you omit the Counts array, the default of 1 is used as the value * for each count. If you include a Counts array, it must include the * same amount of values as the Values array.

*/ inline MetricDatum& WithCounts(Aws::Vector&& value) { SetCounts(std::move(value)); return *this;} /** *

Array of numbers that is used along with the Values array. Each * number in the Count array is the number of times the corresponding * value in the Values array occurred during the period.

If * you omit the Counts array, the default of 1 is used as the value * for each count. If you include a Counts array, it must include the * same amount of values as the Values array.

*/ inline MetricDatum& AddCounts(double value) { m_countsHasBeenSet = true; m_counts.push_back(value); return *this; } /** *

When you are using a Put operation, this defines what unit you * want to use when storing the metric.

In a Get operation, * this displays the unit that is used for the metric.

*/ inline const StandardUnit& GetUnit() const{ return m_unit; } /** *

When you are using a Put operation, this defines what unit you * want to use when storing the metric.

In a Get operation, * this displays the unit that is used for the metric.

*/ inline bool UnitHasBeenSet() const { return m_unitHasBeenSet; } /** *

When you are using a Put operation, this defines what unit you * want to use when storing the metric.

In a Get operation, * this displays the unit that is used for the metric.

*/ inline void SetUnit(const StandardUnit& value) { m_unitHasBeenSet = true; m_unit = value; } /** *

When you are using a Put operation, this defines what unit you * want to use when storing the metric.

In a Get operation, * this displays the unit that is used for the metric.

*/ inline void SetUnit(StandardUnit&& value) { m_unitHasBeenSet = true; m_unit = std::move(value); } /** *

When you are using a Put operation, this defines what unit you * want to use when storing the metric.

In a Get operation, * this displays the unit that is used for the metric.

*/ inline MetricDatum& WithUnit(const StandardUnit& value) { SetUnit(value); return *this;} /** *

When you are using a Put operation, this defines what unit you * want to use when storing the metric.

In a Get operation, * this displays the unit that is used for the metric.

*/ inline MetricDatum& WithUnit(StandardUnit&& value) { SetUnit(std::move(value)); return *this;} /** *

Valid values are 1 and 60. Setting this to 1 specifies this metric as a * high-resolution metric, so that CloudWatch stores the metric with sub-minute * resolution down to one second. Setting this to 60 specifies this metric as a * regular-resolution metric, which CloudWatch stores at 1-minute resolution. * Currently, high resolution is available only for custom metrics. For more * information about high-resolution metrics, see High-Resolution * Metrics in the Amazon CloudWatch User Guide.

This field is * optional, if you do not specify it the default of 60 is used.

*/ inline int GetStorageResolution() const{ return m_storageResolution; } /** *

Valid values are 1 and 60. Setting this to 1 specifies this metric as a * high-resolution metric, so that CloudWatch stores the metric with sub-minute * resolution down to one second. Setting this to 60 specifies this metric as a * regular-resolution metric, which CloudWatch stores at 1-minute resolution. * Currently, high resolution is available only for custom metrics. For more * information about high-resolution metrics, see High-Resolution * Metrics in the Amazon CloudWatch User Guide.

This field is * optional, if you do not specify it the default of 60 is used.

*/ inline bool StorageResolutionHasBeenSet() const { return m_storageResolutionHasBeenSet; } /** *

Valid values are 1 and 60. Setting this to 1 specifies this metric as a * high-resolution metric, so that CloudWatch stores the metric with sub-minute * resolution down to one second. Setting this to 60 specifies this metric as a * regular-resolution metric, which CloudWatch stores at 1-minute resolution. * Currently, high resolution is available only for custom metrics. For more * information about high-resolution metrics, see High-Resolution * Metrics in the Amazon CloudWatch User Guide.

This field is * optional, if you do not specify it the default of 60 is used.

*/ inline void SetStorageResolution(int value) { m_storageResolutionHasBeenSet = true; m_storageResolution = value; } /** *

Valid values are 1 and 60. Setting this to 1 specifies this metric as a * high-resolution metric, so that CloudWatch stores the metric with sub-minute * resolution down to one second. Setting this to 60 specifies this metric as a * regular-resolution metric, which CloudWatch stores at 1-minute resolution. * Currently, high resolution is available only for custom metrics. For more * information about high-resolution metrics, see High-Resolution * Metrics in the Amazon CloudWatch User Guide.

This field is * optional, if you do not specify it the default of 60 is used.

*/ inline MetricDatum& WithStorageResolution(int value) { SetStorageResolution(value); return *this;} private: Aws::String m_metricName; bool m_metricNameHasBeenSet = false; Aws::Vector m_dimensions; bool m_dimensionsHasBeenSet = false; Aws::Utils::DateTime m_timestamp; bool m_timestampHasBeenSet = false; double m_value; bool m_valueHasBeenSet = false; StatisticSet m_statisticValues; bool m_statisticValuesHasBeenSet = false; Aws::Vector m_values; bool m_valuesHasBeenSet = false; Aws::Vector m_counts; bool m_countsHasBeenSet = false; StandardUnit m_unit; bool m_unitHasBeenSet = false; int m_storageResolution; bool m_storageResolutionHasBeenSet = false; }; } // namespace Model } // namespace CloudWatch } // namespace Aws