Struct aws_sdk_evidently::types::builders::ExperimentBuilder

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

A builder for Experiment.

Implementations

impl ExperimentBuilder

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

The ARN of the experiment.

This field is required.

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

The ARN of the experiment.

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

The ARN of the experiment.

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

The name of the experiment.

This field is required.

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

The name of the experiment.

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

The name of the experiment.

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

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

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

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

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

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

pub fn status(self, input: ExperimentStatus) -> Self

The current state of the experiment.

This field is required.

pub fn set_status(self, input: Option<ExperimentStatus>) -> Self

The current state of the experiment.

pub fn get_status(&self) -> &Option<ExperimentStatus>

The current state of the experiment.

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

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 set_status_reason(self, input: Option<String>) -> Self

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 get_status_reason(&self) -> &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.

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

A description of the experiment.

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

A description of the experiment.

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

A description of the experiment.

pub fn created_time(self, input: DateTime) -> Self

The date and time that the experiment is first created.

This field is required.

pub fn set_created_time(self, input: Option<DateTime>) -> Self

The date and time that the experiment is first created.

pub fn get_created_time(&self) -> &Option<DateTime>

The date and time that the experiment is first created.

pub fn last_updated_time(self, input: DateTime) -> Self

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

This field is required.

pub fn set_last_updated_time(self, input: Option<DateTime>) -> Self

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

pub fn get_last_updated_time(&self) -> &Option<DateTime>

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

pub fn schedule(self, input: ExperimentSchedule) -> Self

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

pub fn set_schedule(self, input: Option<ExperimentSchedule>) -> Self

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

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

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

pub fn execution(self, input: ExperimentExecution) -> Self

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

pub fn set_execution(self, input: Option<ExperimentExecution>) -> Self

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

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

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

pub fn treatments(self, input: Treatment) -> Self

Appends an item to treatments.

To override the contents of this collection use set_treatments.

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

pub fn set_treatments(self, input: Option<Vec<Treatment>>) -> Self

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

pub fn get_treatments(&self) -> &Option<Vec<Treatment>>

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

pub fn metric_goals(self, input: MetricGoal) -> Self

Appends an item to metric_goals.

To override the contents of this collection use set_metric_goals.

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.

pub fn set_metric_goals(self, input: Option<Vec<MetricGoal>>) -> Self

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.

pub fn get_metric_goals(&self) -> &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.

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

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 set_randomization_salt(self, input: Option<String>) -> Self

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 get_randomization_salt(&self) -> &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.

pub fn sampling_rate(self, input: i64) -> Self

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 set_sampling_rate(self, input: Option<i64>) -> Self

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 get_sampling_rate(&self) -> &Option<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, input: impl Into<String>) -> Self

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

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

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

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

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

pub fn type(self, input: ExperimentType) -> Self

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

This field is required.

pub fn set_type(self, input: Option<ExperimentType>) -> Self

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

pub fn get_type(&self) -> &Option<ExperimentType>

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

pub fn online_ab_definition(self, input: OnlineAbDefinition) -> Self

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 set_online_ab_definition(self, input: Option<OnlineAbDefinition>) -> Self

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 get_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, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

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

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

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

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

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

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

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

• arn
• name
• status
• created_time
• last_updated_time
• r#type

Trait Implementations

impl Clone for ExperimentBuilder

fn clone(&self) -> ExperimentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExperimentBuilder

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

Formats the value using the given formatter.

impl Default for ExperimentBuilder

fn default() -> ExperimentBuilder

Returns the “default value” for a type.

impl PartialEq for ExperimentBuilder

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