Struct aws_sdk_iotsitewise::types::builders::MetricBuilder

#[non_exhaustive]
pub struct MetricBuilder { /* private fields */ }

A builder for Metric.

Implementations

impl MetricBuilder

pub fn expression(self, input: impl Into<String>) -> Self

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 IoT SiteWise User Guide.

This field is required.

pub fn set_expression(self, input: Option<String>) -> Self

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 IoT SiteWise User Guide.

pub fn get_expression(&self) -> &Option<String>

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 IoT SiteWise User Guide.

pub fn variables(self, input: ExpressionVariable) -> Self

Appends an item to variables.

To override the contents of this collection use set_variables.

The list of variables used in the expression.

pub fn set_variables(self, input: Option<Vec<ExpressionVariable>>) -> Self

The list of variables used in the expression.

pub fn get_variables(&self) -> &Option<Vec<ExpressionVariable>>

The list of variables used in the expression.

pub fn window(self, input: MetricWindow) -> Self

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

This field is required.

pub fn set_window(self, input: Option<MetricWindow>) -> Self

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

pub fn get_window(&self) -> &Option<MetricWindow>

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

pub fn processing_config(self, input: MetricProcessingConfig) -> Self

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

pub fn set_processing_config( self, input: Option<MetricProcessingConfig> ) -> Self

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

pub fn get_processing_config(&self) -> &Option<MetricProcessingConfig>

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

pub fn build(self) -> Result<Metric, BuildError>

Consumes the builder and constructs a Metric. This method will fail if any of the following fields are not set:

• expression
• variables

Trait Implementations

impl Clone for MetricBuilder

fn clone(&self) -> MetricBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MetricBuilder

fn default() -> MetricBuilder

Returns the “default value” for a type.

impl PartialEq for MetricBuilder

fn eq(&self, other: &MetricBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MetricBuilder