Struct Experiment

#[non_exhaustive]
pub struct Experiment {

    pub arn: String,
    pub name: String,
    pub project: Option<String>,
    pub status: ExperimentStatus,
    pub status_reason: Option<String>,
    pub description: Option<String>,
    pub created_time: DateTime,
    pub last_updated_time: DateTime,
    pub schedule: Option<ExperimentSchedule>,
    pub execution: Option<ExperimentExecution>,
    pub treatments: Option<Vec<Treatment>>,
    pub metric_goals: Option<Vec<MetricGoal>>,
    pub randomization_salt: Option<String>,
    pub sampling_rate: i64,
    pub segment: Option<String>,
    pub type: ExperimentType,
    pub online_ab_definition: Option<OnlineAbDefinition>,
    pub tags: Option<HashMap<String, String>>,
}

A structure containing the configuration details of an 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.

arn: String

The ARN of the experiment.

name: String

The name of the experiment.

project: Option<String>

The name or ARN of the project that contains this experiment.

status: ExperimentStatus

The current state of the experiment.

status_reason: Option<String>

If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

description: Option<String>

A description of the experiment.

created_time: DateTime

The date and time that the experiment is first created.

last_updated_time: DateTime

The date and time that the experiment was most recently updated.

schedule: Option<ExperimentSchedule>

A structure that contains the time and date that Evidently completed the analysis of the experiment.

execution: Option<ExperimentExecution>

A structure that contains the date and time that the experiment started and ended.

treatments: Option<Vec<Treatment>>

An array of structures that describe the configuration of each feature variation used in the experiment.

metric_goals: Option<Vec<MetricGoal>>

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

randomization_salt: Option<String>

This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

sampling_rate: i64

In thousandths of a percent, the amount of the available audience that is allocated to this experiment. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.

segment: Option<String>

The audience segment being used for the experiment, if a segment is being used.

type: ExperimentType

The type of this experiment. Currently, this value must be aws.experiment.onlineab.

online_ab_definition: Option<OnlineAbDefinition>

A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

tags: Option<HashMap<String, String>>

The list of tag keys and values associated with this experiment.

Implementations

impl Experiment

pub fn arn(&self) -> &str

The ARN of the experiment.

pub fn name(&self) -> &str

The name of the experiment.

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

The name or ARN of the project that contains this experiment.

pub fn status(&self) -> &ExperimentStatus

The current state of the experiment.

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

If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

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

A description of the experiment.

pub fn created_time(&self) -> &DateTime

The date and time that the experiment is first created.

pub fn last_updated_time(&self) -> &DateTime

The date and time that the experiment was most recently updated.

pub fn schedule(&self) -> Option<&ExperimentSchedule>

A structure that contains the time and date that Evidently completed the analysis of the experiment.

pub fn execution(&self) -> Option<&ExperimentExecution>

A structure that contains the date and time that the experiment started and ended.

pub fn treatments(&self) -> &[Treatment]

An array of structures that describe the configuration of each feature variation used in the experiment.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .treatments.is_none().

pub fn metric_goals(&self) -> &[MetricGoal]

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_goals.is_none().

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

This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

pub fn sampling_rate(&self) -> i64

In thousandths of a percent, the amount of the available audience that is allocated to this experiment. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.

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

The audience segment being used for the experiment, if a segment is being used.

pub fn type(&self) -> &ExperimentType

The type of this experiment. Currently, this value must be aws.experiment.onlineab.

pub fn online_ab_definition(&self) -> Option<&OnlineAbDefinition>

A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

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

The list of tag keys and values associated with this experiment.

impl Experiment

pub fn builder() -> ExperimentBuilder

Creates a new builder-style object to manufacture Experiment.

Trait Implementations

impl Clone for Experiment

fn clone(&self) -> Experiment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Experiment

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

Formats the value using the given formatter.

impl PartialEq for Experiment

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Experiment