aws-sdk-customerprofiles 1.119.0

// 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)]
pub struct GetRecommenderOutput {
    /// <p>The name of the recommender.</p>
    pub recommender_name: ::std::string::String,
    /// <p>The name of the recipe used by the recommender to generate recommendations.</p>
    pub recommender_recipe_name: crate::types::RecommenderRecipeName,
    /// <p>The name of the recommender schema associated with this recommender.</p>
    pub recommender_schema_name: ::std::option::Option<::std::string::String>,
    /// <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
    pub recommender_config: ::std::option::Option<crate::types::RecommenderConfig>,
    /// <p>A detailed description of the recommender providing information about its purpose and functionality.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>
    pub status: ::std::option::Option<crate::types::RecommenderStatus>,
    /// <p>The timestamp of when the recommender was edited.</p>
    pub last_updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The timestamp of when the recommender was created.</p>
    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>If the recommender fails, provides the reason for the failure.</p>
    pub failure_reason: ::std::option::Option<::std::string::String>,
    /// <p>Information about the most recent update performed on the recommender, including status and timestamp.</p>
    pub latest_recommender_update: ::std::option::Option<crate::types::RecommenderUpdate>,
    /// <p>The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set.</p>
    pub active_recommender_version_name: ::std::option::Option<::std::string::String>,
    /// <p>A set of metrics that provide information about the recommender's training performance and accuracy.</p>
    pub training_metrics: ::std::option::Option<::std::vec::Vec<crate::types::TrainingMetrics>>,
    /// <p>The tags used to organize, track, or control access for this resource.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    _request_id: Option<String>,
}
impl GetRecommenderOutput {
    /// <p>The name of the recommender.</p>
    pub fn recommender_name(&self) -> &str {
        use std::ops::Deref;
        self.recommender_name.deref()
    }
    /// <p>The name of the recipe used by the recommender to generate recommendations.</p>
    pub fn recommender_recipe_name(&self) -> &crate::types::RecommenderRecipeName {
        &self.recommender_recipe_name
    }
    /// <p>The name of the recommender schema associated with this recommender.</p>
    pub fn recommender_schema_name(&self) -> ::std::option::Option<&str> {
        self.recommender_schema_name.as_deref()
    }
    /// <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
    pub fn recommender_config(&self) -> ::std::option::Option<&crate::types::RecommenderConfig> {
        self.recommender_config.as_ref()
    }
    /// <p>A detailed description of the recommender providing information about its purpose and functionality.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::RecommenderStatus> {
        self.status.as_ref()
    }
    /// <p>The timestamp of when the recommender was edited.</p>
    pub fn last_updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_updated_at.as_ref()
    }
    /// <p>The timestamp of when the recommender was created.</p>
    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_at.as_ref()
    }
    /// <p>If the recommender fails, provides the reason for the failure.</p>
    pub fn failure_reason(&self) -> ::std::option::Option<&str> {
        self.failure_reason.as_deref()
    }
    /// <p>Information about the most recent update performed on the recommender, including status and timestamp.</p>
    pub fn latest_recommender_update(&self) -> ::std::option::Option<&crate::types::RecommenderUpdate> {
        self.latest_recommender_update.as_ref()
    }
    /// <p>The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set.</p>
    pub fn active_recommender_version_name(&self) -> ::std::option::Option<&str> {
        self.active_recommender_version_name.as_deref()
    }
    /// <p>A set of metrics that provide information about the recommender's training performance and accuracy.</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 `.training_metrics.is_none()`.
    pub fn training_metrics(&self) -> &[crate::types::TrainingMetrics] {
        self.training_metrics.as_deref().unwrap_or_default()
    }
    /// <p>The tags used to organize, track, or control access for this resource.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl ::std::fmt::Debug for GetRecommenderOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetRecommenderOutput");
        formatter.field("recommender_name", &self.recommender_name);
        formatter.field("recommender_recipe_name", &self.recommender_recipe_name);
        formatter.field("recommender_schema_name", &self.recommender_schema_name);
        formatter.field("recommender_config", &self.recommender_config);
        formatter.field("description", &"*** Sensitive Data Redacted ***");
        formatter.field("status", &self.status);
        formatter.field("last_updated_at", &self.last_updated_at);
        formatter.field("created_at", &self.created_at);
        formatter.field("failure_reason", &self.failure_reason);
        formatter.field("latest_recommender_update", &self.latest_recommender_update);
        formatter.field("active_recommender_version_name", &self.active_recommender_version_name);
        formatter.field("training_metrics", &self.training_metrics);
        formatter.field("tags", &self.tags);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
impl ::aws_types::request_id::RequestId for GetRecommenderOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetRecommenderOutput {
    /// Creates a new builder-style object to manufacture [`GetRecommenderOutput`](crate::operation::get_recommender::GetRecommenderOutput).
    pub fn builder() -> crate::operation::get_recommender::builders::GetRecommenderOutputBuilder {
        crate::operation::get_recommender::builders::GetRecommenderOutputBuilder::default()
    }
}

/// A builder for [`GetRecommenderOutput`](crate::operation::get_recommender::GetRecommenderOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct GetRecommenderOutputBuilder {
    pub(crate) recommender_name: ::std::option::Option<::std::string::String>,
    pub(crate) recommender_recipe_name: ::std::option::Option<crate::types::RecommenderRecipeName>,
    pub(crate) recommender_schema_name: ::std::option::Option<::std::string::String>,
    pub(crate) recommender_config: ::std::option::Option<crate::types::RecommenderConfig>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::RecommenderStatus>,
    pub(crate) last_updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
    pub(crate) latest_recommender_update: ::std::option::Option<crate::types::RecommenderUpdate>,
    pub(crate) active_recommender_version_name: ::std::option::Option<::std::string::String>,
    pub(crate) training_metrics: ::std::option::Option<::std::vec::Vec<crate::types::TrainingMetrics>>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    _request_id: Option<String>,
}
impl GetRecommenderOutputBuilder {
    /// <p>The name of the recommender.</p>
    /// This field is required.
    pub fn recommender_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.recommender_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the recommender.</p>
    pub fn set_recommender_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.recommender_name = input;
        self
    }
    /// <p>The name of the recommender.</p>
    pub fn get_recommender_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.recommender_name
    }
    /// <p>The name of the recipe used by the recommender to generate recommendations.</p>
    /// This field is required.
    pub fn recommender_recipe_name(mut self, input: crate::types::RecommenderRecipeName) -> Self {
        self.recommender_recipe_name = ::std::option::Option::Some(input);
        self
    }
    /// <p>The name of the recipe used by the recommender to generate recommendations.</p>
    pub fn set_recommender_recipe_name(mut self, input: ::std::option::Option<crate::types::RecommenderRecipeName>) -> Self {
        self.recommender_recipe_name = input;
        self
    }
    /// <p>The name of the recipe used by the recommender to generate recommendations.</p>
    pub fn get_recommender_recipe_name(&self) -> &::std::option::Option<crate::types::RecommenderRecipeName> {
        &self.recommender_recipe_name
    }
    /// <p>The name of the recommender schema associated with this recommender.</p>
    pub fn recommender_schema_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.recommender_schema_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the recommender schema associated with this recommender.</p>
    pub fn set_recommender_schema_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.recommender_schema_name = input;
        self
    }
    /// <p>The name of the recommender schema associated with this recommender.</p>
    pub fn get_recommender_schema_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.recommender_schema_name
    }
    /// <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
    pub fn recommender_config(mut self, input: crate::types::RecommenderConfig) -> Self {
        self.recommender_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
    pub fn set_recommender_config(mut self, input: ::std::option::Option<crate::types::RecommenderConfig>) -> Self {
        self.recommender_config = input;
        self
    }
    /// <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
    pub fn get_recommender_config(&self) -> &::std::option::Option<crate::types::RecommenderConfig> {
        &self.recommender_config
    }
    /// <p>A detailed description of the recommender providing information about its purpose and functionality.</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>A detailed description of the recommender providing information about its purpose and functionality.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A detailed description of the recommender providing information about its purpose and functionality.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>
    pub fn status(mut self, input: crate::types::RecommenderStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::RecommenderStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::RecommenderStatus> {
        &self.status
    }
    /// <p>The timestamp of when the recommender was edited.</p>
    pub fn last_updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_updated_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp of when the recommender was edited.</p>
    pub fn set_last_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_updated_at = input;
        self
    }
    /// <p>The timestamp of when the recommender was edited.</p>
    pub fn get_last_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_updated_at
    }
    /// <p>The timestamp of when the recommender was created.</p>
    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp of when the recommender was created.</p>
    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_at = input;
        self
    }
    /// <p>The timestamp of when the recommender was created.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>If the recommender fails, provides the reason for the failure.</p>
    pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.failure_reason = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>If the recommender fails, provides the reason for the failure.</p>
    pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.failure_reason = input;
        self
    }
    /// <p>If the recommender fails, provides the reason for the failure.</p>
    pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
        &self.failure_reason
    }
    /// <p>Information about the most recent update performed on the recommender, including status and timestamp.</p>
    pub fn latest_recommender_update(mut self, input: crate::types::RecommenderUpdate) -> Self {
        self.latest_recommender_update = ::std::option::Option::Some(input);
        self
    }
    /// <p>Information about the most recent update performed on the recommender, including status and timestamp.</p>
    pub fn set_latest_recommender_update(mut self, input: ::std::option::Option<crate::types::RecommenderUpdate>) -> Self {
        self.latest_recommender_update = input;
        self
    }
    /// <p>Information about the most recent update performed on the recommender, including status and timestamp.</p>
    pub fn get_latest_recommender_update(&self) -> &::std::option::Option<crate::types::RecommenderUpdate> {
        &self.latest_recommender_update
    }
    /// <p>The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set.</p>
    pub fn active_recommender_version_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.active_recommender_version_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set.</p>
    pub fn set_active_recommender_version_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.active_recommender_version_name = input;
        self
    }
    /// <p>The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set.</p>
    pub fn get_active_recommender_version_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.active_recommender_version_name
    }
    /// Appends an item to `training_metrics`.
    ///
    /// To override the contents of this collection use [`set_training_metrics`](Self::set_training_metrics).
    ///
    /// <p>A set of metrics that provide information about the recommender's training performance and accuracy.</p>
    pub fn training_metrics(mut self, input: crate::types::TrainingMetrics) -> Self {
        let mut v = self.training_metrics.unwrap_or_default();
        v.push(input);
        self.training_metrics = ::std::option::Option::Some(v);
        self
    }
    /// <p>A set of metrics that provide information about the recommender's training performance and accuracy.</p>
    pub fn set_training_metrics(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TrainingMetrics>>) -> Self {
        self.training_metrics = input;
        self
    }
    /// <p>A set of metrics that provide information about the recommender's training performance and accuracy.</p>
    pub fn get_training_metrics(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TrainingMetrics>> {
        &self.training_metrics
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags used to organize, track, or control access for this resource.</p>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.tags.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.tags = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    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 [`GetRecommenderOutput`](crate::operation::get_recommender::GetRecommenderOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`recommender_name`](crate::operation::get_recommender::builders::GetRecommenderOutputBuilder::recommender_name)
    /// - [`recommender_recipe_name`](crate::operation::get_recommender::builders::GetRecommenderOutputBuilder::recommender_recipe_name)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::get_recommender::GetRecommenderOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_recommender::GetRecommenderOutput {
            recommender_name: self.recommender_name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "recommender_name",
                    "recommender_name was not specified but it is required when building GetRecommenderOutput",
                )
            })?,
            recommender_recipe_name: self.recommender_recipe_name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "recommender_recipe_name",
                    "recommender_recipe_name was not specified but it is required when building GetRecommenderOutput",
                )
            })?,
            recommender_schema_name: self.recommender_schema_name,
            recommender_config: self.recommender_config,
            description: self.description,
            status: self.status,
            last_updated_at: self.last_updated_at,
            created_at: self.created_at,
            failure_reason: self.failure_reason,
            latest_recommender_update: self.latest_recommender_update,
            active_recommender_version_name: self.active_recommender_version_name,
            training_metrics: self.training_metrics,
            tags: self.tags,
            _request_id: self._request_id,
        })
    }
}
impl ::std::fmt::Debug for GetRecommenderOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetRecommenderOutputBuilder");
        formatter.field("recommender_name", &self.recommender_name);
        formatter.field("recommender_recipe_name", &self.recommender_recipe_name);
        formatter.field("recommender_schema_name", &self.recommender_schema_name);
        formatter.field("recommender_config", &self.recommender_config);
        formatter.field("description", &"*** Sensitive Data Redacted ***");
        formatter.field("status", &self.status);
        formatter.field("last_updated_at", &self.last_updated_at);
        formatter.field("created_at", &self.created_at);
        formatter.field("failure_reason", &self.failure_reason);
        formatter.field("latest_recommender_update", &self.latest_recommender_update);
        formatter.field("active_recommender_version_name", &self.active_recommender_version_name);
        formatter.field("training_metrics", &self.training_metrics);
        formatter.field("tags", &self.tags);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}