aws-sdk-connect 1.169.0

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

/// <p>Information about a contact evaluation.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Evaluation {
    /// <p>A unique identifier for the contact evaluation.</p>
    pub evaluation_id: ::std::string::String,
    /// <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
    pub evaluation_arn: ::std::string::String,
    /// <p>Metadata about the contact evaluation.</p>
    pub metadata: ::std::option::Option<crate::types::EvaluationMetadata>,
    /// <p>A map of question identifiers to answer value.</p>
    pub answers: ::std::collections::HashMap<::std::string::String, crate::types::EvaluationAnswerOutput>,
    /// <p>A map of question identifiers to note value.</p>
    pub notes: ::std::collections::HashMap<::std::string::String, crate::types::EvaluationNote>,
    /// <p>The status of the contact evaluation.</p>
    pub status: crate::types::EvaluationStatus,
    /// <p>A map of item (section or question) identifiers to score value.</p>
    pub scores: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationScore>>,
    /// <p>The timestamp for when the evaluation was created.</p>
    pub created_time: ::aws_smithy_types::DateTime,
    /// <p>The timestamp for when the evaluation was last updated.</p>
    pub last_modified_time: ::aws_smithy_types::DateTime,
    /// <p>Type of the evaluation.</p>
    pub evaluation_type: ::std::option::Option<crate::types::EvaluationType>,
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl Evaluation {
    /// <p>A unique identifier for the contact evaluation.</p>
    pub fn evaluation_id(&self) -> &str {
        use std::ops::Deref;
        self.evaluation_id.deref()
    }
    /// <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
    pub fn evaluation_arn(&self) -> &str {
        use std::ops::Deref;
        self.evaluation_arn.deref()
    }
    /// <p>Metadata about the contact evaluation.</p>
    pub fn metadata(&self) -> ::std::option::Option<&crate::types::EvaluationMetadata> {
        self.metadata.as_ref()
    }
    /// <p>A map of question identifiers to answer value.</p>
    pub fn answers(&self) -> &::std::collections::HashMap<::std::string::String, crate::types::EvaluationAnswerOutput> {
        &self.answers
    }
    /// <p>A map of question identifiers to note value.</p>
    pub fn notes(&self) -> &::std::collections::HashMap<::std::string::String, crate::types::EvaluationNote> {
        &self.notes
    }
    /// <p>The status of the contact evaluation.</p>
    pub fn status(&self) -> &crate::types::EvaluationStatus {
        &self.status
    }
    /// <p>A map of item (section or question) identifiers to score value.</p>
    pub fn scores(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::EvaluationScore>> {
        self.scores.as_ref()
    }
    /// <p>The timestamp for when the evaluation was created.</p>
    pub fn created_time(&self) -> &::aws_smithy_types::DateTime {
        &self.created_time
    }
    /// <p>The timestamp for when the evaluation was last updated.</p>
    pub fn last_modified_time(&self) -> &::aws_smithy_types::DateTime {
        &self.last_modified_time
    }
    /// <p>Type of the evaluation.</p>
    pub fn evaluation_type(&self) -> ::std::option::Option<&crate::types::EvaluationType> {
        self.evaluation_type.as_ref()
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl Evaluation {
    /// Creates a new builder-style object to manufacture [`Evaluation`](crate::types::Evaluation).
    pub fn builder() -> crate::types::builders::EvaluationBuilder {
        crate::types::builders::EvaluationBuilder::default()
    }
}

/// A builder for [`Evaluation`](crate::types::Evaluation).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct EvaluationBuilder {
    pub(crate) evaluation_id: ::std::option::Option<::std::string::String>,
    pub(crate) evaluation_arn: ::std::option::Option<::std::string::String>,
    pub(crate) metadata: ::std::option::Option<crate::types::EvaluationMetadata>,
    pub(crate) answers: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationAnswerOutput>>,
    pub(crate) notes: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationNote>>,
    pub(crate) status: ::std::option::Option<crate::types::EvaluationStatus>,
    pub(crate) scores: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationScore>>,
    pub(crate) created_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) evaluation_type: ::std::option::Option<crate::types::EvaluationType>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl EvaluationBuilder {
    /// <p>A unique identifier for the contact evaluation.</p>
    /// This field is required.
    pub fn evaluation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.evaluation_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique identifier for the contact evaluation.</p>
    pub fn set_evaluation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.evaluation_id = input;
        self
    }
    /// <p>A unique identifier for the contact evaluation.</p>
    pub fn get_evaluation_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.evaluation_id
    }
    /// <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
    /// This field is required.
    pub fn evaluation_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.evaluation_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
    pub fn set_evaluation_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.evaluation_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
    pub fn get_evaluation_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.evaluation_arn
    }
    /// <p>Metadata about the contact evaluation.</p>
    /// This field is required.
    pub fn metadata(mut self, input: crate::types::EvaluationMetadata) -> Self {
        self.metadata = ::std::option::Option::Some(input);
        self
    }
    /// <p>Metadata about the contact evaluation.</p>
    pub fn set_metadata(mut self, input: ::std::option::Option<crate::types::EvaluationMetadata>) -> Self {
        self.metadata = input;
        self
    }
    /// <p>Metadata about the contact evaluation.</p>
    pub fn get_metadata(&self) -> &::std::option::Option<crate::types::EvaluationMetadata> {
        &self.metadata
    }
    /// Adds a key-value pair to `answers`.
    ///
    /// To override the contents of this collection use [`set_answers`](Self::set_answers).
    ///
    /// <p>A map of question identifiers to answer value.</p>
    pub fn answers(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::EvaluationAnswerOutput) -> Self {
        let mut hash_map = self.answers.unwrap_or_default();
        hash_map.insert(k.into(), v);
        self.answers = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>A map of question identifiers to answer value.</p>
    pub fn set_answers(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationAnswerOutput>>,
    ) -> Self {
        self.answers = input;
        self
    }
    /// <p>A map of question identifiers to answer value.</p>
    pub fn get_answers(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationAnswerOutput>> {
        &self.answers
    }
    /// Adds a key-value pair to `notes`.
    ///
    /// To override the contents of this collection use [`set_notes`](Self::set_notes).
    ///
    /// <p>A map of question identifiers to note value.</p>
    pub fn notes(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::EvaluationNote) -> Self {
        let mut hash_map = self.notes.unwrap_or_default();
        hash_map.insert(k.into(), v);
        self.notes = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>A map of question identifiers to note value.</p>
    pub fn set_notes(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationNote>>,
    ) -> Self {
        self.notes = input;
        self
    }
    /// <p>A map of question identifiers to note value.</p>
    pub fn get_notes(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationNote>> {
        &self.notes
    }
    /// <p>The status of the contact evaluation.</p>
    /// This field is required.
    pub fn status(mut self, input: crate::types::EvaluationStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the contact evaluation.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::EvaluationStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the contact evaluation.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::EvaluationStatus> {
        &self.status
    }
    /// Adds a key-value pair to `scores`.
    ///
    /// To override the contents of this collection use [`set_scores`](Self::set_scores).
    ///
    /// <p>A map of item (section or question) identifiers to score value.</p>
    pub fn scores(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::EvaluationScore) -> Self {
        let mut hash_map = self.scores.unwrap_or_default();
        hash_map.insert(k.into(), v);
        self.scores = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>A map of item (section or question) identifiers to score value.</p>
    pub fn set_scores(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationScore>>,
    ) -> Self {
        self.scores = input;
        self
    }
    /// <p>A map of item (section or question) identifiers to score value.</p>
    pub fn get_scores(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::EvaluationScore>> {
        &self.scores
    }
    /// <p>The timestamp for when the evaluation was created.</p>
    /// This field is required.
    pub fn created_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp for when the evaluation was created.</p>
    pub fn set_created_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_time = input;
        self
    }
    /// <p>The timestamp for when the evaluation was created.</p>
    pub fn get_created_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_time
    }
    /// <p>The timestamp for when the evaluation was last updated.</p>
    /// This field is required.
    pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_modified_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp for when the evaluation was last updated.</p>
    pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_modified_time = input;
        self
    }
    /// <p>The timestamp for when the evaluation was last updated.</p>
    pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_modified_time
    }
    /// <p>Type of the evaluation.</p>
    pub fn evaluation_type(mut self, input: crate::types::EvaluationType) -> Self {
        self.evaluation_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>Type of the evaluation.</p>
    pub fn set_evaluation_type(mut self, input: ::std::option::Option<crate::types::EvaluationType>) -> Self {
        self.evaluation_type = input;
        self
    }
    /// <p>Type of the evaluation.</p>
    pub fn get_evaluation_type(&self) -> &::std::option::Option<crate::types::EvaluationType> {
        &self.evaluation_type
    }
    /// 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. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</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. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</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. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`Evaluation`](crate::types::Evaluation).
    /// This method will fail if any of the following fields are not set:
    /// - [`evaluation_id`](crate::types::builders::EvaluationBuilder::evaluation_id)
    /// - [`evaluation_arn`](crate::types::builders::EvaluationBuilder::evaluation_arn)
    /// - [`answers`](crate::types::builders::EvaluationBuilder::answers)
    /// - [`notes`](crate::types::builders::EvaluationBuilder::notes)
    /// - [`status`](crate::types::builders::EvaluationBuilder::status)
    /// - [`created_time`](crate::types::builders::EvaluationBuilder::created_time)
    /// - [`last_modified_time`](crate::types::builders::EvaluationBuilder::last_modified_time)
    pub fn build(self) -> ::std::result::Result<crate::types::Evaluation, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::Evaluation {
            evaluation_id: self.evaluation_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "evaluation_id",
                    "evaluation_id was not specified but it is required when building Evaluation",
                )
            })?,
            evaluation_arn: self.evaluation_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "evaluation_arn",
                    "evaluation_arn was not specified but it is required when building Evaluation",
                )
            })?,
            metadata: self.metadata,
            answers: self.answers.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "answers",
                    "answers was not specified but it is required when building Evaluation",
                )
            })?,
            notes: self.notes.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "notes",
                    "notes was not specified but it is required when building Evaluation",
                )
            })?,
            status: self.status.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "status",
                    "status was not specified but it is required when building Evaluation",
                )
            })?,
            scores: self.scores,
            created_time: self.created_time.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "created_time",
                    "created_time was not specified but it is required when building Evaluation",
                )
            })?,
            last_modified_time: self.last_modified_time.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "last_modified_time",
                    "last_modified_time was not specified but it is required when building Evaluation",
                )
            })?,
            evaluation_type: self.evaluation_type,
            tags: self.tags,
        })
    }
}