Struct aws_sdk_autoscaling::types::builders::MetricDataQueryBuilder

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

A builder for MetricDataQuery.

Implementations

impl MetricDataQueryBuilder

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

A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. 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 underscores. The first character must be a lowercase letter.

This field is required.

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

A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. 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 underscores. The first character must be a lowercase letter.

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

A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. 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 underscores. The first character must be a lowercase letter.

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

The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

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

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

The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

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

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

The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

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

pub fn metric_stat(self, input: MetricStat) -> Self

Information about the metric data to return.

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

pub fn set_metric_stat(self, input: Option<MetricStat>) -> Self

Information about the metric data to return.

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

pub fn get_metric_stat(&self) -> &Option<MetricStat>

Information about the metric data to return.

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

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

A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

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

A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

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

A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

pub fn return_data(self, input: bool) -> Self

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

pub fn set_return_data(self, input: Option<bool>) -> Self

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

pub fn get_return_data(&self) -> &Option<bool>

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

pub fn build(self) -> MetricDataQuery

Consumes the builder and constructs a MetricDataQuery.

Trait Implementations

impl Clone for MetricDataQueryBuilder

fn clone(&self) -> MetricDataQueryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDataQueryBuilder

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

Formats the value using the given formatter.

impl Default for MetricDataQueryBuilder

fn default() -> MetricDataQueryBuilder

Returns the “default value” for a type.

impl PartialEq for MetricDataQueryBuilder

fn eq(&self, other: &MetricDataQueryBuilder) -> 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 MetricDataQueryBuilder