Struct aws_sdk_evidently::model::Experiment
source · [−]#[non_exhaustive]pub struct Experiment {Show 17 fields
pub arn: Option<String>,
pub name: Option<String>,
pub project: Option<String>,
pub status: Option<ExperimentStatus>,
pub status_reason: Option<String>,
pub description: Option<String>,
pub created_time: Option<DateTime>,
pub last_updated_time: Option<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 type: Option<ExperimentType>,
pub online_ab_definition: Option<OnlineAbDefinition>,
pub tags: Option<HashMap<String, String>>,
}
Expand description
A structure containing the configuration details of an experiment.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.arn: Option<String>
The ARN of the experiment.
name: Option<String>
The name of the experiment.
project: Option<String>
The name or ARN of the project that contains this experiment.
status: Option<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: Option<DateTime>
The date and time that the experiment is first created.
last_updated_time: Option<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.
type: Option<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.
The list of tag keys and values associated with this experiment.
Implementations
sourceimpl Experiment
impl Experiment
sourcepub fn project(&self) -> Option<&str>
pub fn project(&self) -> Option<&str>
The name or ARN of the project that contains this experiment.
sourcepub fn status(&self) -> Option<&ExperimentStatus>
pub fn status(&self) -> Option<&ExperimentStatus>
The current state of the experiment.
sourcepub fn status_reason(&self) -> Option<&str>
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.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the experiment.
sourcepub fn created_time(&self) -> Option<&DateTime>
pub fn created_time(&self) -> Option<&DateTime>
The date and time that the experiment is first created.
sourcepub fn last_updated_time(&self) -> Option<&DateTime>
pub fn last_updated_time(&self) -> Option<&DateTime>
The date and time that the experiment was most recently updated.
sourcepub fn schedule(&self) -> Option<&ExperimentSchedule>
pub fn schedule(&self) -> Option<&ExperimentSchedule>
A structure that contains the time and date that Evidently completed the analysis of the experiment.
sourcepub fn execution(&self) -> Option<&ExperimentExecution>
pub fn execution(&self) -> Option<&ExperimentExecution>
A structure that contains the date and time that the experiment started and ended.
sourcepub fn treatments(&self) -> Option<&[Treatment]>
pub fn treatments(&self) -> Option<&[Treatment]>
An array of structures that describe the configuration of each feature variation used in the experiment.
sourcepub fn metric_goals(&self) -> Option<&[MetricGoal]>
pub fn metric_goals(&self) -> Option<&[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.
sourcepub fn randomization_salt(&self) -> Option<&str>
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
.
sourcepub fn sampling_rate(&self) -> i64
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.
sourcepub fn type(&self) -> Option<&ExperimentType>
pub fn type(&self) -> Option<&ExperimentType>
The type of this experiment. Currently, this value must be aws.experiment.onlineab
.
sourcepub fn online_ab_definition(&self) -> Option<&OnlineAbDefinition>
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.
The list of tag keys and values associated with this experiment.
sourceimpl Experiment
impl Experiment
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture Experiment
Trait Implementations
sourceimpl Clone for Experiment
impl Clone for Experiment
sourcefn clone(&self) -> Experiment
fn clone(&self) -> Experiment
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for Experiment
impl Debug for Experiment
sourceimpl PartialEq<Experiment> for Experiment
impl PartialEq<Experiment> for Experiment
sourcefn eq(&self, other: &Experiment) -> bool
fn eq(&self, other: &Experiment) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &Experiment) -> bool
fn ne(&self, other: &Experiment) -> bool
This method tests for !=
.
impl StructuralPartialEq for Experiment
Auto Trait Implementations
impl RefUnwindSafe for Experiment
impl Send for Experiment
impl Sync for Experiment
impl Unpin for Experiment
impl UnwindSafe for Experiment
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more