Struct aws_sdk_rum::types::builders::MetricDefinitionBuilder

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

A builder for MetricDefinition.

Implementations

impl MetricDefinitionBuilder

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

The ID of this metric definition.

This field is required.

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

The ID of this metric definition.

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

The ID of this metric definition.

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

The name of the metric that is defined in this structure.

This field is required.

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

The name of the metric that is defined in this structure.

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

The name of the metric that is defined in this structure.

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

The field within the event object that the metric value is sourced from.

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

The field within the event object that the metric value is sourced from.

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

The field within the event object that the metric value is sourced from.

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

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

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

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

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

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

pub fn dimension_keys(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to dimension_keys.

To override the contents of this collection use set_dimension_keys.

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

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

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

pub fn get_dimension_keys(&self) -> &Option<HashMap<String, String>>

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

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

The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

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

The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

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

The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

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

If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

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

If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

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

If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

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

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

• metric_definition_id
• name

Trait Implementations

impl Clone for MetricDefinitionBuilder

fn clone(&self) -> MetricDefinitionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDefinitionBuilder

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

Formats the value using the given formatter.

impl Default for MetricDefinitionBuilder

fn default() -> MetricDefinitionBuilder

Returns the “default value” for a type.

impl PartialEq for MetricDefinitionBuilder

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