aws-sdk-appconfig 1.110.0

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Describes an experiment definition, including the target audience, feature flag, treatments, and current status.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetExperimentDefinitionOutput {
    /// <p>The application ID.</p>
    pub application_id: ::std::option::Option<::std::string::String>,
    /// <p>The experiment definition ID.</p>
    pub id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the experiment definition.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The hypothesis that the experiment is designed to validate.</p>
    pub hypothesis: ::std::option::Option<::std::string::String>,
    /// <p>The current status of the experiment definition. Valid values: <code>ACTIVE</code>, <code>IDLE</code>, <code>ARCHIVED</code>.</p>
    pub status: ::std::option::Option<crate::types::ExperimentDefinitionStatus>,
    /// <p>The configuration profile ID associated with the experiment.</p>
    pub configuration_profile_id: ::std::option::Option<::std::string::String>,
    /// <p>The environment ID where the experiment runs.</p>
    pub environment_id: ::std::option::Option<::std::string::String>,
    /// <p>The key of the feature flag used by the experiment.</p>
    pub flag_key: ::std::option::Option<::std::string::String>,
    /// <p>The rule that defines which users are eligible to be assigned to treatments.</p>
    pub audience_rule: ::std::option::Option<::std::string::String>,
    /// <p>A description of the intended audience for the experiment.</p>
    pub audience_description: ::std::option::Option<::std::string::String>,
    /// <p>The conditions under which the winning treatment should be launched.</p>
    pub launch_criteria: ::std::option::Option<::std::string::String>,
    /// <p>The list of treatments defined for the experiment.</p>
    pub treatments: ::std::option::Option<::std::vec::Vec<crate::types::Treatment>>,
    /// <p>The control treatment used as the baseline for comparison.</p>
    pub control: ::std::option::Option<crate::types::Treatment>,
    /// <p>The date and time the experiment definition was created, in ISO 8601 format.</p>
    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>
    pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.</p>
    pub kms_key_identifier: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetExperimentDefinitionOutput {
    /// <p>The application ID.</p>
    pub fn application_id(&self) -> ::std::option::Option<&str> {
        self.application_id.as_deref()
    }
    /// <p>The experiment definition ID.</p>
    pub fn id(&self) -> ::std::option::Option<&str> {
        self.id.as_deref()
    }
    /// <p>The name of the experiment definition.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The hypothesis that the experiment is designed to validate.</p>
    pub fn hypothesis(&self) -> ::std::option::Option<&str> {
        self.hypothesis.as_deref()
    }
    /// <p>The current status of the experiment definition. Valid values: <code>ACTIVE</code>, <code>IDLE</code>, <code>ARCHIVED</code>.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::ExperimentDefinitionStatus> {
        self.status.as_ref()
    }
    /// <p>The configuration profile ID associated with the experiment.</p>
    pub fn configuration_profile_id(&self) -> ::std::option::Option<&str> {
        self.configuration_profile_id.as_deref()
    }
    /// <p>The environment ID where the experiment runs.</p>
    pub fn environment_id(&self) -> ::std::option::Option<&str> {
        self.environment_id.as_deref()
    }
    /// <p>The key of the feature flag used by the experiment.</p>
    pub fn flag_key(&self) -> ::std::option::Option<&str> {
        self.flag_key.as_deref()
    }
    /// <p>The rule that defines which users are eligible to be assigned to treatments.</p>
    pub fn audience_rule(&self) -> ::std::option::Option<&str> {
        self.audience_rule.as_deref()
    }
    /// <p>A description of the intended audience for the experiment.</p>
    pub fn audience_description(&self) -> ::std::option::Option<&str> {
        self.audience_description.as_deref()
    }
    /// <p>The conditions under which the winning treatment should be launched.</p>
    pub fn launch_criteria(&self) -> ::std::option::Option<&str> {
        self.launch_criteria.as_deref()
    }
    /// <p>The list of treatments defined for 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::Treatment] {
        self.treatments.as_deref().unwrap_or_default()
    }
    /// <p>The control treatment used as the baseline for comparison.</p>
    pub fn control(&self) -> ::std::option::Option<&crate::types::Treatment> {
        self.control.as_ref()
    }
    /// <p>The date and time the experiment definition was created, in ISO 8601 format.</p>
    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_at.as_ref()
    }
    /// <p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>
    pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.updated_at.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.</p>
    pub fn kms_key_identifier(&self) -> ::std::option::Option<&str> {
        self.kms_key_identifier.as_deref()
    }
}
impl ::aws_types::request_id::RequestId for GetExperimentDefinitionOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetExperimentDefinitionOutput {
    /// Creates a new builder-style object to manufacture [`GetExperimentDefinitionOutput`](crate::operation::get_experiment_definition::GetExperimentDefinitionOutput).
    pub fn builder() -> crate::operation::get_experiment_definition::builders::GetExperimentDefinitionOutputBuilder {
        crate::operation::get_experiment_definition::builders::GetExperimentDefinitionOutputBuilder::default()
    }
}

/// A builder for [`GetExperimentDefinitionOutput`](crate::operation::get_experiment_definition::GetExperimentDefinitionOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetExperimentDefinitionOutputBuilder {
    pub(crate) application_id: ::std::option::Option<::std::string::String>,
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) hypothesis: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::ExperimentDefinitionStatus>,
    pub(crate) configuration_profile_id: ::std::option::Option<::std::string::String>,
    pub(crate) environment_id: ::std::option::Option<::std::string::String>,
    pub(crate) flag_key: ::std::option::Option<::std::string::String>,
    pub(crate) audience_rule: ::std::option::Option<::std::string::String>,
    pub(crate) audience_description: ::std::option::Option<::std::string::String>,
    pub(crate) launch_criteria: ::std::option::Option<::std::string::String>,
    pub(crate) treatments: ::std::option::Option<::std::vec::Vec<crate::types::Treatment>>,
    pub(crate) control: ::std::option::Option<crate::types::Treatment>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) kms_key_identifier: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetExperimentDefinitionOutputBuilder {
    /// <p>The application ID.</p>
    pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.application_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The application ID.</p>
    pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.application_id = input;
        self
    }
    /// <p>The application ID.</p>
    pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.application_id
    }
    /// <p>The experiment definition ID.</p>
    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The experiment definition ID.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The experiment definition ID.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The name of the experiment definition.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the experiment definition.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the experiment definition.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The hypothesis that the experiment is designed to validate.</p>
    pub fn hypothesis(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.hypothesis = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The hypothesis that the experiment is designed to validate.</p>
    pub fn set_hypothesis(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.hypothesis = input;
        self
    }
    /// <p>The hypothesis that the experiment is designed to validate.</p>
    pub fn get_hypothesis(&self) -> &::std::option::Option<::std::string::String> {
        &self.hypothesis
    }
    /// <p>The current status of the experiment definition. Valid values: <code>ACTIVE</code>, <code>IDLE</code>, <code>ARCHIVED</code>.</p>
    pub fn status(mut self, input: crate::types::ExperimentDefinitionStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the experiment definition. Valid values: <code>ACTIVE</code>, <code>IDLE</code>, <code>ARCHIVED</code>.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::ExperimentDefinitionStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the experiment definition. Valid values: <code>ACTIVE</code>, <code>IDLE</code>, <code>ARCHIVED</code>.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::ExperimentDefinitionStatus> {
        &self.status
    }
    /// <p>The configuration profile ID associated with the experiment.</p>
    pub fn configuration_profile_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.configuration_profile_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The configuration profile ID associated with the experiment.</p>
    pub fn set_configuration_profile_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.configuration_profile_id = input;
        self
    }
    /// <p>The configuration profile ID associated with the experiment.</p>
    pub fn get_configuration_profile_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.configuration_profile_id
    }
    /// <p>The environment ID where the experiment runs.</p>
    pub fn environment_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.environment_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The environment ID where the experiment runs.</p>
    pub fn set_environment_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.environment_id = input;
        self
    }
    /// <p>The environment ID where the experiment runs.</p>
    pub fn get_environment_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.environment_id
    }
    /// <p>The key of the feature flag used by the experiment.</p>
    pub fn flag_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.flag_key = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The key of the feature flag used by the experiment.</p>
    pub fn set_flag_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.flag_key = input;
        self
    }
    /// <p>The key of the feature flag used by the experiment.</p>
    pub fn get_flag_key(&self) -> &::std::option::Option<::std::string::String> {
        &self.flag_key
    }
    /// <p>The rule that defines which users are eligible to be assigned to treatments.</p>
    pub fn audience_rule(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.audience_rule = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The rule that defines which users are eligible to be assigned to treatments.</p>
    pub fn set_audience_rule(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.audience_rule = input;
        self
    }
    /// <p>The rule that defines which users are eligible to be assigned to treatments.</p>
    pub fn get_audience_rule(&self) -> &::std::option::Option<::std::string::String> {
        &self.audience_rule
    }
    /// <p>A description of the intended audience for the experiment.</p>
    pub fn audience_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.audience_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the intended audience for the experiment.</p>
    pub fn set_audience_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.audience_description = input;
        self
    }
    /// <p>A description of the intended audience for the experiment.</p>
    pub fn get_audience_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.audience_description
    }
    /// <p>The conditions under which the winning treatment should be launched.</p>
    pub fn launch_criteria(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.launch_criteria = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The conditions under which the winning treatment should be launched.</p>
    pub fn set_launch_criteria(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.launch_criteria = input;
        self
    }
    /// <p>The conditions under which the winning treatment should be launched.</p>
    pub fn get_launch_criteria(&self) -> &::std::option::Option<::std::string::String> {
        &self.launch_criteria
    }
    /// Appends an item to `treatments`.
    ///
    /// To override the contents of this collection use [`set_treatments`](Self::set_treatments).
    ///
    /// <p>The list of treatments defined for the experiment.</p>
    pub fn treatments(mut self, input: crate::types::Treatment) -> Self {
        let mut v = self.treatments.unwrap_or_default();
        v.push(input);
        self.treatments = ::std::option::Option::Some(v);
        self
    }
    /// <p>The list of treatments defined for the experiment.</p>
    pub fn set_treatments(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Treatment>>) -> Self {
        self.treatments = input;
        self
    }
    /// <p>The list of treatments defined for the experiment.</p>
    pub fn get_treatments(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Treatment>> {
        &self.treatments
    }
    /// <p>The control treatment used as the baseline for comparison.</p>
    pub fn control(mut self, input: crate::types::Treatment) -> Self {
        self.control = ::std::option::Option::Some(input);
        self
    }
    /// <p>The control treatment used as the baseline for comparison.</p>
    pub fn set_control(mut self, input: ::std::option::Option<crate::types::Treatment>) -> Self {
        self.control = input;
        self
    }
    /// <p>The control treatment used as the baseline for comparison.</p>
    pub fn get_control(&self) -> &::std::option::Option<crate::types::Treatment> {
        &self.control
    }
    /// <p>The date and time the experiment definition was created, in ISO 8601 format.</p>
    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time the experiment definition was created, in ISO 8601 format.</p>
    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_at = input;
        self
    }
    /// <p>The date and time the experiment definition was created, in ISO 8601 format.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>
    pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.updated_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>
    pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.updated_at = input;
        self
    }
    /// <p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>
    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.updated_at
    }
    /// <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.</p>
    pub fn kms_key_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.kms_key_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.</p>
    pub fn set_kms_key_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.kms_key_identifier = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.</p>
    pub fn get_kms_key_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.kms_key_identifier
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`GetExperimentDefinitionOutput`](crate::operation::get_experiment_definition::GetExperimentDefinitionOutput).
    pub fn build(self) -> crate::operation::get_experiment_definition::GetExperimentDefinitionOutput {
        crate::operation::get_experiment_definition::GetExperimentDefinitionOutput {
            application_id: self.application_id,
            id: self.id,
            name: self.name,
            hypothesis: self.hypothesis,
            status: self.status,
            configuration_profile_id: self.configuration_profile_id,
            environment_id: self.environment_id,
            flag_key: self.flag_key,
            audience_rule: self.audience_rule,
            audience_description: self.audience_description,
            launch_criteria: self.launch_criteria,
            treatments: self.treatments,
            control: self.control,
            created_at: self.created_at,
            updated_at: self.updated_at,
            kms_key_identifier: self.kms_key_identifier,
            _request_id: self._request_id,
        }
    }
}