1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateExperimentInput {
/// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
pub project: ::std::option::Option<::std::string::String>,
/// <p>The name of the experiment to update.</p>
pub experiment: ::std::option::Option<::std::string::String>,
/// <p>An optional description of the experiment.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>An array of structures that define the variations being tested in the experiment.</p>
pub treatments: ::std::option::Option<::std::vec::Vec<crate::types::TreatmentConfig>>,
/// <p>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.</p>
pub metric_goals: ::std::option::Option<::std::vec::Vec<crate::types::MetricGoalConfig>>,
/// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
pub randomization_salt: ::std::option::Option<::std::string::String>,
/// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
/// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
pub sampling_rate: ::std::option::Option<i64>,
/// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
pub segment: ::std::option::Option<::std::string::String>,
/// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
pub remove_segment: ::std::option::Option<bool>,
/// <p>A structure that contains the configuration of which variation o 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.</p>
pub online_ab_config: ::std::option::Option<crate::types::OnlineAbConfig>,
}
impl UpdateExperimentInput {
/// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
pub fn project(&self) -> ::std::option::Option<&str> {
self.project.as_deref()
}
/// <p>The name of the experiment to update.</p>
pub fn experiment(&self) -> ::std::option::Option<&str> {
self.experiment.as_deref()
}
/// <p>An optional description of the experiment.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>An array of structures that define the variations being tested in the experiment.</p>
///
/// 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 treatments(&self) -> &[crate::types::TreatmentConfig] {
self.treatments.as_deref().unwrap_or_default()
}
/// <p>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.</p>
///
/// 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 metric_goals(&self) -> &[crate::types::MetricGoalConfig] {
self.metric_goals.as_deref().unwrap_or_default()
}
/// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
pub fn randomization_salt(&self) -> ::std::option::Option<&str> {
self.randomization_salt.as_deref()
}
/// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
/// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
pub fn sampling_rate(&self) -> ::std::option::Option<i64> {
self.sampling_rate
}
/// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn segment(&self) -> ::std::option::Option<&str> {
self.segment.as_deref()
}
/// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn remove_segment(&self) -> ::std::option::Option<bool> {
self.remove_segment
}
/// <p>A structure that contains the configuration of which variation o 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.</p>
pub fn online_ab_config(&self) -> ::std::option::Option<&crate::types::OnlineAbConfig> {
self.online_ab_config.as_ref()
}
}
impl UpdateExperimentInput {
/// Creates a new builder-style object to manufacture [`UpdateExperimentInput`](crate::operation::update_experiment::UpdateExperimentInput).
pub fn builder() -> crate::operation::update_experiment::builders::UpdateExperimentInputBuilder {
crate::operation::update_experiment::builders::UpdateExperimentInputBuilder::default()
}
}
/// A builder for [`UpdateExperimentInput`](crate::operation::update_experiment::UpdateExperimentInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateExperimentInputBuilder {
pub(crate) project: ::std::option::Option<::std::string::String>,
pub(crate) experiment: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) treatments: ::std::option::Option<::std::vec::Vec<crate::types::TreatmentConfig>>,
pub(crate) metric_goals: ::std::option::Option<::std::vec::Vec<crate::types::MetricGoalConfig>>,
pub(crate) randomization_salt: ::std::option::Option<::std::string::String>,
pub(crate) sampling_rate: ::std::option::Option<i64>,
pub(crate) segment: ::std::option::Option<::std::string::String>,
pub(crate) remove_segment: ::std::option::Option<bool>,
pub(crate) online_ab_config: ::std::option::Option<crate::types::OnlineAbConfig>,
}
impl UpdateExperimentInputBuilder {
/// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
/// This field is required.
pub fn project(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.project = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
pub fn set_project(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.project = input;
self
}
/// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
pub fn get_project(&self) -> &::std::option::Option<::std::string::String> {
&self.project
}
/// <p>The name of the experiment to update.</p>
/// This field is required.
pub fn experiment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.experiment = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the experiment to update.</p>
pub fn set_experiment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.experiment = input;
self
}
/// <p>The name of the experiment to update.</p>
pub fn get_experiment(&self) -> &::std::option::Option<::std::string::String> {
&self.experiment
}
/// <p>An optional description of the experiment.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>An optional description of the experiment.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>An optional description of the experiment.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// Appends an item to `treatments`.
///
/// To override the contents of this collection use [`set_treatments`](Self::set_treatments).
///
/// <p>An array of structures that define the variations being tested in the experiment.</p>
pub fn treatments(mut self, input: crate::types::TreatmentConfig) -> Self {
let mut v = self.treatments.unwrap_or_default();
v.push(input);
self.treatments = ::std::option::Option::Some(v);
self
}
/// <p>An array of structures that define the variations being tested in the experiment.</p>
pub fn set_treatments(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TreatmentConfig>>) -> Self {
self.treatments = input;
self
}
/// <p>An array of structures that define the variations being tested in the experiment.</p>
pub fn get_treatments(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TreatmentConfig>> {
&self.treatments
}
/// Appends an item to `metric_goals`.
///
/// To override the contents of this collection use [`set_metric_goals`](Self::set_metric_goals).
///
/// <p>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.</p>
pub fn metric_goals(mut self, input: crate::types::MetricGoalConfig) -> Self {
let mut v = self.metric_goals.unwrap_or_default();
v.push(input);
self.metric_goals = ::std::option::Option::Some(v);
self
}
/// <p>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.</p>
pub fn set_metric_goals(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MetricGoalConfig>>) -> Self {
self.metric_goals = input;
self
}
/// <p>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.</p>
pub fn get_metric_goals(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MetricGoalConfig>> {
&self.metric_goals
}
/// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
pub fn randomization_salt(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.randomization_salt = ::std::option::Option::Some(input.into());
self
}
/// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
pub fn set_randomization_salt(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.randomization_salt = input;
self
}
/// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
pub fn get_randomization_salt(&self) -> &::std::option::Option<::std::string::String> {
&self.randomization_salt
}
/// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
/// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
pub fn sampling_rate(mut self, input: i64) -> Self {
self.sampling_rate = ::std::option::Option::Some(input);
self
}
/// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
/// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
pub fn set_sampling_rate(mut self, input: ::std::option::Option<i64>) -> Self {
self.sampling_rate = input;
self
}
/// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
/// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
pub fn get_sampling_rate(&self) -> &::std::option::Option<i64> {
&self.sampling_rate
}
/// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn segment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.segment = ::std::option::Option::Some(input.into());
self
}
/// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn set_segment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.segment = input;
self
}
/// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn get_segment(&self) -> &::std::option::Option<::std::string::String> {
&self.segment
}
/// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn remove_segment(mut self, input: bool) -> Self {
self.remove_segment = ::std::option::Option::Some(input);
self
}
/// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn set_remove_segment(mut self, input: ::std::option::Option<bool>) -> Self {
self.remove_segment = input;
self
}
/// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
pub fn get_remove_segment(&self) -> &::std::option::Option<bool> {
&self.remove_segment
}
/// <p>A structure that contains the configuration of which variation o 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.</p>
pub fn online_ab_config(mut self, input: crate::types::OnlineAbConfig) -> Self {
self.online_ab_config = ::std::option::Option::Some(input);
self
}
/// <p>A structure that contains the configuration of which variation o 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.</p>
pub fn set_online_ab_config(mut self, input: ::std::option::Option<crate::types::OnlineAbConfig>) -> Self {
self.online_ab_config = input;
self
}
/// <p>A structure that contains the configuration of which variation o 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.</p>
pub fn get_online_ab_config(&self) -> &::std::option::Option<crate::types::OnlineAbConfig> {
&self.online_ab_config
}
/// Consumes the builder and constructs a [`UpdateExperimentInput`](crate::operation::update_experiment::UpdateExperimentInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_experiment::UpdateExperimentInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_experiment::UpdateExperimentInput {
project: self.project,
experiment: self.experiment,
description: self.description,
treatments: self.treatments,
metric_goals: self.metric_goals,
randomization_salt: self.randomization_salt,
sampling_rate: self.sampling_rate,
segment: self.segment,
remove_segment: self.remove_segment,
online_ab_config: self.online_ab_config,
})
}
}