AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudWatch::Model::MetricStat Class Reference

#include <MetricStat.h>

Public Member Functions

 MetricStat ()
 
 MetricStat (const Aws::Utils::Xml::XmlNode &xmlNode)
 
MetricStatoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const MetricGetMetric () const
 
bool MetricHasBeenSet () const
 
void SetMetric (const Metric &value)
 
void SetMetric (Metric &&value)
 
MetricStatWithMetric (const Metric &value)
 
MetricStatWithMetric (Metric &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
MetricStatWithPeriod (int value)
 
const Aws::StringGetStat () const
 
bool StatHasBeenSet () const
 
void SetStat (const Aws::String &value)
 
void SetStat (Aws::String &&value)
 
void SetStat (const char *value)
 
MetricStatWithStat (const Aws::String &value)
 
MetricStatWithStat (Aws::String &&value)
 
MetricStatWithStat (const char *value)
 
const StandardUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const StandardUnit &value)
 
void SetUnit (StandardUnit &&value)
 
MetricStatWithUnit (const StandardUnit &value)
 
MetricStatWithUnit (StandardUnit &&value)
 

Detailed Description

This structure defines the metric to be returned, along with the statistics, period, and units.

See Also:

AWS API Reference

Definition at line 34 of file MetricStat.h.

Constructor & Destructor Documentation

◆ MetricStat() [1/2]

Aws::CloudWatch::Model::MetricStat::MetricStat ( )

◆ MetricStat() [2/2]

Aws::CloudWatch::Model::MetricStat::MetricStat ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ GetMetric()

const Metric& Aws::CloudWatch::Model::MetricStat::GetMetric ( ) const
inline

The metric to return, including the metric name, namespace, and dimensions.

Definition at line 49 of file MetricStat.h.

◆ GetPeriod()

int Aws::CloudWatch::Model::MetricStat::GetPeriod ( ) const
inline

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

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 97 of file MetricStat.h.

◆ GetStat()

const Aws::String& Aws::CloudWatch::Model::MetricStat::GetStat ( ) const
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 155 of file MetricStat.h.

◆ GetUnit()

const StandardUnit& Aws::CloudWatch::Model::MetricStat::GetUnit ( ) const
inline

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

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 210 of file MetricStat.h.

◆ MetricHasBeenSet()

bool Aws::CloudWatch::Model::MetricStat::MetricHasBeenSet ( ) const
inline

The metric to return, including the metric name, namespace, and dimensions.

Definition at line 55 of file MetricStat.h.

◆ operator=()

MetricStat& Aws::CloudWatch::Model::MetricStat::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::CloudWatch::Model::MetricStat::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::CloudWatch::Model::MetricStat::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ PeriodHasBeenSet()

bool Aws::CloudWatch::Model::MetricStat::PeriodHasBeenSet ( ) const
inline

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

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 114 of file MetricStat.h.

◆ SetMetric() [1/2]

void Aws::CloudWatch::Model::MetricStat::SetMetric ( const Metric value)
inline

The metric to return, including the metric name, namespace, and dimensions.

Definition at line 61 of file MetricStat.h.

◆ SetMetric() [2/2]

void Aws::CloudWatch::Model::MetricStat::SetMetric ( Metric &&  value)
inline

The metric to return, including the metric name, namespace, and dimensions.

Definition at line 67 of file MetricStat.h.

◆ SetPeriod()

void Aws::CloudWatch::Model::MetricStat::SetPeriod ( int  value)
inline

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

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 131 of file MetricStat.h.

◆ SetStat() [1/3]

void Aws::CloudWatch::Model::MetricStat::SetStat ( Aws::String &&  value)
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 173 of file MetricStat.h.

◆ SetStat() [2/3]

void Aws::CloudWatch::Model::MetricStat::SetStat ( const Aws::String value)
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 167 of file MetricStat.h.

◆ SetStat() [3/3]

void Aws::CloudWatch::Model::MetricStat::SetStat ( const char *  value)
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 179 of file MetricStat.h.

◆ SetUnit() [1/2]

void Aws::CloudWatch::Model::MetricStat::SetUnit ( const StandardUnit value)
inline

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

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 234 of file MetricStat.h.

◆ SetUnit() [2/2]

void Aws::CloudWatch::Model::MetricStat::SetUnit ( StandardUnit &&  value)
inline

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

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 246 of file MetricStat.h.

◆ StatHasBeenSet()

bool Aws::CloudWatch::Model::MetricStat::StatHasBeenSet ( ) const
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 161 of file MetricStat.h.

◆ UnitHasBeenSet()

bool Aws::CloudWatch::Model::MetricStat::UnitHasBeenSet ( ) const
inline

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

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 222 of file MetricStat.h.

◆ WithMetric() [1/2]

MetricStat& Aws::CloudWatch::Model::MetricStat::WithMetric ( const Metric value)
inline

The metric to return, including the metric name, namespace, and dimensions.

Definition at line 73 of file MetricStat.h.

◆ WithMetric() [2/2]

MetricStat& Aws::CloudWatch::Model::MetricStat::WithMetric ( Metric &&  value)
inline

The metric to return, including the metric name, namespace, and dimensions.

Definition at line 79 of file MetricStat.h.

◆ WithPeriod()

MetricStat& Aws::CloudWatch::Model::MetricStat::WithPeriod ( int  value)
inline

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

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 148 of file MetricStat.h.

◆ WithStat() [1/3]

MetricStat& Aws::CloudWatch::Model::MetricStat::WithStat ( Aws::String &&  value)
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 191 of file MetricStat.h.

◆ WithStat() [2/3]

MetricStat& Aws::CloudWatch::Model::MetricStat::WithStat ( const Aws::String value)
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 185 of file MetricStat.h.

◆ WithStat() [3/3]

MetricStat& Aws::CloudWatch::Model::MetricStat::WithStat ( const char *  value)
inline

The statistic to return. It can include any CloudWatch statistic or extended statistic.

Definition at line 197 of file MetricStat.h.

◆ WithUnit() [1/2]

MetricStat& Aws::CloudWatch::Model::MetricStat::WithUnit ( const StandardUnit value)
inline

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

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 258 of file MetricStat.h.

◆ WithUnit() [2/2]

MetricStat& Aws::CloudWatch::Model::MetricStat::WithUnit ( StandardUnit &&  value)
inline

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

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 270 of file MetricStat.h.


The documentation for this class was generated from the following file: