aws-sdk-connect 1.172.0

AWS SDK for Amazon Connect Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Contains information about a notification, including its content, priority, recipients, and metadata.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Notification {
    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.</p>
    pub content: ::std::option::Option<::std::collections::HashMap<crate::types::LocaleCode, ::std::string::String>>,
    /// <p>The unique identifier for the notification.</p>
    pub id: ::std::string::String,
    /// <p>The Amazon Resource Name (ARN) of the notification.</p>
    pub arn: ::std::string::String,
    /// <p>The priority level of the notification. Valid values are URGENT, HIGH, and LOW.</p>
    pub priority: ::std::option::Option<crate::types::NotificationPriority>,
    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.</p>
    pub recipients: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The timestamp when the notification was last modified.</p>
    pub last_modified_time: ::aws_smithy_types::DateTime,
    /// <p>The timestamp when the notification was created.</p>
    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The timestamp when the notification expires and is no longer displayed to users.</p>
    pub expires_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The AWS Region where the notification was last modified.</p>
    pub last_modified_region: ::std::option::Option<::std::string::String>,
    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl Notification {
    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.</p>
    pub fn content(&self) -> ::std::option::Option<&::std::collections::HashMap<crate::types::LocaleCode, ::std::string::String>> {
        self.content.as_ref()
    }
    /// <p>The unique identifier for the notification.</p>
    pub fn id(&self) -> &str {
        use std::ops::Deref;
        self.id.deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the notification.</p>
    pub fn arn(&self) -> &str {
        use std::ops::Deref;
        self.arn.deref()
    }
    /// <p>The priority level of the notification. Valid values are URGENT, HIGH, and LOW.</p>
    pub fn priority(&self) -> ::std::option::Option<&crate::types::NotificationPriority> {
        self.priority.as_ref()
    }
    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.</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 `.recipients.is_none()`.
    pub fn recipients(&self) -> &[::std::string::String] {
        self.recipients.as_deref().unwrap_or_default()
    }
    /// <p>The timestamp when the notification was last modified.</p>
    pub fn last_modified_time(&self) -> &::aws_smithy_types::DateTime {
        &self.last_modified_time
    }
    /// <p>The timestamp when the notification was created.</p>
    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_at.as_ref()
    }
    /// <p>The timestamp when the notification expires and is no longer displayed to users.</p>
    pub fn expires_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.expires_at.as_ref()
    }
    /// <p>The AWS Region where the notification was last modified.</p>
    pub fn last_modified_region(&self) -> ::std::option::Option<&str> {
        self.last_modified_region.as_deref()
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl Notification {
    /// Creates a new builder-style object to manufacture [`Notification`](crate::types::Notification).
    pub fn builder() -> crate::types::builders::NotificationBuilder {
        crate::types::builders::NotificationBuilder::default()
    }
}

/// A builder for [`Notification`](crate::types::Notification).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct NotificationBuilder {
    pub(crate) content: ::std::option::Option<::std::collections::HashMap<crate::types::LocaleCode, ::std::string::String>>,
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) priority: ::std::option::Option<crate::types::NotificationPriority>,
    pub(crate) recipients: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) expires_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_modified_region: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl NotificationBuilder {
    /// Adds a key-value pair to `content`.
    ///
    /// To override the contents of this collection use [`set_content`](Self::set_content).
    ///
    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.</p>
    pub fn content(mut self, k: crate::types::LocaleCode, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.content.unwrap_or_default();
        hash_map.insert(k, v.into());
        self.content = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.</p>
    pub fn set_content(mut self, input: ::std::option::Option<::std::collections::HashMap<crate::types::LocaleCode, ::std::string::String>>) -> Self {
        self.content = input;
        self
    }
    /// <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.</p>
    pub fn get_content(&self) -> &::std::option::Option<::std::collections::HashMap<crate::types::LocaleCode, ::std::string::String>> {
        &self.content
    }
    /// <p>The unique identifier for the notification.</p>
    /// This field is required.
    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 unique identifier for the notification.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The unique identifier for the notification.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The Amazon Resource Name (ARN) of the notification.</p>
    /// This field is required.
    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the notification.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the notification.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>The priority level of the notification. Valid values are URGENT, HIGH, and LOW.</p>
    pub fn priority(mut self, input: crate::types::NotificationPriority) -> Self {
        self.priority = ::std::option::Option::Some(input);
        self
    }
    /// <p>The priority level of the notification. Valid values are URGENT, HIGH, and LOW.</p>
    pub fn set_priority(mut self, input: ::std::option::Option<crate::types::NotificationPriority>) -> Self {
        self.priority = input;
        self
    }
    /// <p>The priority level of the notification. Valid values are URGENT, HIGH, and LOW.</p>
    pub fn get_priority(&self) -> &::std::option::Option<crate::types::NotificationPriority> {
        &self.priority
    }
    /// Appends an item to `recipients`.
    ///
    /// To override the contents of this collection use [`set_recipients`](Self::set_recipients).
    ///
    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.</p>
    pub fn recipients(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.recipients.unwrap_or_default();
        v.push(input.into());
        self.recipients = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.</p>
    pub fn set_recipients(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.recipients = input;
        self
    }
    /// <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.</p>
    pub fn get_recipients(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.recipients
    }
    /// <p>The timestamp when the notification was last modified.</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 when the notification was last modified.</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 when the notification was last modified.</p>
    pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_modified_time
    }
    /// <p>The timestamp when the notification 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 when the notification 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 when the notification was created.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>The timestamp when the notification expires and is no longer displayed to users.</p>
    pub fn expires_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.expires_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when the notification expires and is no longer displayed to users.</p>
    pub fn set_expires_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.expires_at = input;
        self
    }
    /// <p>The timestamp when the notification expires and is no longer displayed to users.</p>
    pub fn get_expires_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.expires_at
    }
    /// <p>The AWS Region where the notification was last modified.</p>
    pub fn last_modified_region(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.last_modified_region = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The AWS Region where the notification was last modified.</p>
    pub fn set_last_modified_region(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.last_modified_region = input;
        self
    }
    /// <p>The AWS Region where the notification was last modified.</p>
    pub fn get_last_modified_region(&self) -> &::std::option::Option<::std::string::String> {
        &self.last_modified_region
    }
    /// 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, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</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, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</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, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</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 [`Notification`](crate::types::Notification).
    /// This method will fail if any of the following fields are not set:
    /// - [`id`](crate::types::builders::NotificationBuilder::id)
    /// - [`arn`](crate::types::builders::NotificationBuilder::arn)
    /// - [`last_modified_time`](crate::types::builders::NotificationBuilder::last_modified_time)
    pub fn build(self) -> ::std::result::Result<crate::types::Notification, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::Notification {
            content: self.content,
            id: self.id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "id",
                    "id was not specified but it is required when building Notification",
                )
            })?,
            arn: self.arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "arn",
                    "arn was not specified but it is required when building Notification",
                )
            })?,
            priority: self.priority,
            recipients: self.recipients,
            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 Notification",
                )
            })?,
            created_at: self.created_at,
            expires_at: self.expires_at,
            last_modified_region: self.last_modified_region,
            tags: self.tags,
        })
    }
}