Struct aws_sdk_evidently::types::MetricDefinition

#[non_exhaustive]
pub struct MetricDefinition {
    pub name: Option<String>,
    pub entity_id_key: Option<String>,
    pub value_key: Option<String>,
    pub event_pattern: Option<String>,
    pub unit_label: Option<String>,
}

This structure defines a metric that is being used to evaluate the variations during a launch or experiment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the metric.

entity_id_key: Option<String>

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

value_key: Option<String>

The value that is tracked to produce the metric.

event_pattern: Option<String>

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

unit_label: Option<String>

The label for the units that the metric is measuring.

Implementations

impl MetricDefinition

pub fn name(&self) -> Option<&str>

The name of the metric.

pub fn entity_id_key(&self) -> Option<&str>

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

pub fn value_key(&self) -> Option<&str>

The value that is tracked to produce the metric.

pub fn event_pattern(&self) -> Option<&str>

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

pub fn unit_label(&self) -> Option<&str>

The label for the units that the metric is measuring.

impl MetricDefinition

pub fn builder() -> MetricDefinitionBuilder

Creates a new builder-style object to manufacture MetricDefinition.

Trait Implementations

impl Clone for MetricDefinition

fn clone(&self) -> MetricDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDefinition

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

Formats the value using the given formatter.

impl PartialEq for MetricDefinition

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