AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTSiteWise::Model::Metric Class Reference

#include <Metric.h>

Public Member Functions

 Metric ()
 
 Metric (Aws::Utils::Json::JsonView jsonValue)
 
Metricoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetExpression () const
 
bool ExpressionHasBeenSet () const
 
void SetExpression (const Aws::String &value)
 
void SetExpression (Aws::String &&value)
 
void SetExpression (const char *value)
 
MetricWithExpression (const Aws::String &value)
 
MetricWithExpression (Aws::String &&value)
 
MetricWithExpression (const char *value)
 
const Aws::Vector< ExpressionVariable > & GetVariables () const
 
bool VariablesHasBeenSet () const
 
void SetVariables (const Aws::Vector< ExpressionVariable > &value)
 
void SetVariables (Aws::Vector< ExpressionVariable > &&value)
 
MetricWithVariables (const Aws::Vector< ExpressionVariable > &value)
 
MetricWithVariables (Aws::Vector< ExpressionVariable > &&value)
 
MetricAddVariables (const ExpressionVariable &value)
 
MetricAddVariables (ExpressionVariable &&value)
 
const MetricWindowGetWindow () const
 
bool WindowHasBeenSet () const
 
void SetWindow (const MetricWindow &value)
 
void SetWindow (MetricWindow &&value)
 
MetricWithWindow (const MetricWindow &value)
 
MetricWithWindow (MetricWindow &&value)
 

Detailed Description

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

For more information, see Metrics in the AWS IoT SiteWise User Guide.

See Also:

AWS API Reference

Definition at line 44 of file Metric.h.

Constructor & Destructor Documentation

◆ Metric() [1/2]

Aws::IoTSiteWise::Model::Metric::Metric ( )

◆ Metric() [2/2]

Aws::IoTSiteWise::Model::Metric::Metric ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddVariables() [1/2]

Metric& Aws::IoTSiteWise::Model::Metric::AddVariables ( const ExpressionVariable value)
inline

The list of variables used in the expression.

Definition at line 159 of file Metric.h.

◆ AddVariables() [2/2]

Metric& Aws::IoTSiteWise::Model::Metric::AddVariables ( ExpressionVariable &&  value)
inline

The list of variables used in the expression.

Definition at line 164 of file Metric.h.

◆ ExpressionHasBeenSet()

bool Aws::IoTSiteWise::Model::Metric::ExpressionHasBeenSet ( ) const
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 69 of file Metric.h.

◆ GetExpression()

const Aws::String& Aws::IoTSiteWise::Model::Metric::GetExpression ( ) const
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 60 of file Metric.h.

◆ GetVariables()

const Aws::Vector<ExpressionVariable>& Aws::IoTSiteWise::Model::Metric::GetVariables ( ) const
inline

The list of variables used in the expression.

Definition at line 129 of file Metric.h.

◆ GetWindow()

const MetricWindow& Aws::IoTSiteWise::Model::Metric::GetWindow ( ) const
inline

The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

Definition at line 172 of file Metric.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoTSiteWise::Model::Metric::Jsonize ( ) const

◆ operator=()

Metric& Aws::IoTSiteWise::Model::Metric::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetExpression() [1/3]

void Aws::IoTSiteWise::Model::Metric::SetExpression ( const Aws::String value)
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 78 of file Metric.h.

◆ SetExpression() [2/3]

void Aws::IoTSiteWise::Model::Metric::SetExpression ( Aws::String &&  value)
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 87 of file Metric.h.

◆ SetExpression() [3/3]

void Aws::IoTSiteWise::Model::Metric::SetExpression ( const char *  value)
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 96 of file Metric.h.

◆ SetVariables() [1/2]

void Aws::IoTSiteWise::Model::Metric::SetVariables ( const Aws::Vector< ExpressionVariable > &  value)
inline

The list of variables used in the expression.

Definition at line 139 of file Metric.h.

◆ SetVariables() [2/2]

void Aws::IoTSiteWise::Model::Metric::SetVariables ( Aws::Vector< ExpressionVariable > &&  value)
inline

The list of variables used in the expression.

Definition at line 144 of file Metric.h.

◆ SetWindow() [1/2]

void Aws::IoTSiteWise::Model::Metric::SetWindow ( const MetricWindow value)
inline

The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

Definition at line 186 of file Metric.h.

◆ SetWindow() [2/2]

void Aws::IoTSiteWise::Model::Metric::SetWindow ( MetricWindow &&  value)
inline

The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

Definition at line 193 of file Metric.h.

◆ VariablesHasBeenSet()

bool Aws::IoTSiteWise::Model::Metric::VariablesHasBeenSet ( ) const
inline

The list of variables used in the expression.

Definition at line 134 of file Metric.h.

◆ WindowHasBeenSet()

bool Aws::IoTSiteWise::Model::Metric::WindowHasBeenSet ( ) const
inline

The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

Definition at line 179 of file Metric.h.

◆ WithExpression() [1/3]

Metric& Aws::IoTSiteWise::Model::Metric::WithExpression ( const Aws::String value)
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 105 of file Metric.h.

◆ WithExpression() [2/3]

Metric& Aws::IoTSiteWise::Model::Metric::WithExpression ( Aws::String &&  value)
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 114 of file Metric.h.

◆ WithExpression() [3/3]

Metric& Aws::IoTSiteWise::Model::Metric::WithExpression ( const char *  value)
inline

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

Definition at line 123 of file Metric.h.

◆ WithVariables() [1/2]

Metric& Aws::IoTSiteWise::Model::Metric::WithVariables ( const Aws::Vector< ExpressionVariable > &  value)
inline

The list of variables used in the expression.

Definition at line 149 of file Metric.h.

◆ WithVariables() [2/2]

Metric& Aws::IoTSiteWise::Model::Metric::WithVariables ( Aws::Vector< ExpressionVariable > &&  value)
inline

The list of variables used in the expression.

Definition at line 154 of file Metric.h.

◆ WithWindow() [1/2]

Metric& Aws::IoTSiteWise::Model::Metric::WithWindow ( const MetricWindow value)
inline

The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

Definition at line 200 of file Metric.h.

◆ WithWindow() [2/2]

Metric& Aws::IoTSiteWise::Model::Metric::WithWindow ( MetricWindow &&  value)
inline

The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.

Definition at line 207 of file Metric.h.


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