aws-sdk-quicksight 1.136.0

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

/// <p>An agent resource in Amazon QuickSight that provides AI-powered conversational experiences.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct Agent {
    /// <p>The Amazon Resource Names (ARNs) of the spaces attached to the agent.</p>
    pub spaces: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The Amazon Resource Names (ARNs) of the action connectors attached to the agent.</p>
    pub action_connectors: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>A description of the agent.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The icon identifier for the agent.</p>
    pub icon_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the agent.</p>
    pub name: ::std::string::String,
    /// <p>A list of starter prompts that are displayed to users when they begin interacting with the agent.</p>
    pub starter_prompts: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The welcome message that is displayed when a user starts a conversation with the agent.</p>
    pub welcome_message: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the agent.</p>
    pub arn: ::std::string::String,
    /// <p>The unique identifier for the agent.</p>
    pub agent_id: ::std::string::String,
    /// <p>The lifecycle state of the agent. Valid values are <code>PREVIEW</code> and <code>PUBLISHED</code>.</p>
    pub agent_lifecycle: crate::types::AgentLifecycle,
    /// <p>The status of the agent.</p>
    pub agent_status: crate::types::AgentStatus,
    /// <p>The date and time that the agent was created.</p>
    pub created_at: ::aws_smithy_types::DateTime,
    /// <p>The identity of the user who created the agent.</p>
    pub creator: ::std::string::String,
    /// <p>The custom prompt interface configuration for the agent.</p>
    pub custom_prompt_interface: ::std::option::Option<crate::types::CustomPromptInterface>,
    /// <p>An error message associated with the agent, if applicable.</p>
    pub error_message: ::std::option::Option<::std::string::String>,
    /// <p>The date and time that the agent was last updated.</p>
    pub updated_at: ::aws_smithy_types::DateTime,
}
impl Agent {
    /// <p>The Amazon Resource Names (ARNs) of the spaces attached to the agent.</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 `.spaces.is_none()`.
    pub fn spaces(&self) -> &[::std::string::String] {
        self.spaces.as_deref().unwrap_or_default()
    }
    /// <p>The Amazon Resource Names (ARNs) of the action connectors attached to the agent.</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 `.action_connectors.is_none()`.
    pub fn action_connectors(&self) -> &[::std::string::String] {
        self.action_connectors.as_deref().unwrap_or_default()
    }
    /// <p>A description of the agent.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The icon identifier for the agent.</p>
    pub fn icon_id(&self) -> ::std::option::Option<&str> {
        self.icon_id.as_deref()
    }
    /// <p>The name of the agent.</p>
    pub fn name(&self) -> &str {
        use std::ops::Deref;
        self.name.deref()
    }
    /// <p>A list of starter prompts that are displayed to users when they begin interacting with the agent.</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 `.starter_prompts.is_none()`.
    pub fn starter_prompts(&self) -> &[::std::string::String] {
        self.starter_prompts.as_deref().unwrap_or_default()
    }
    /// <p>The welcome message that is displayed when a user starts a conversation with the agent.</p>
    pub fn welcome_message(&self) -> ::std::option::Option<&str> {
        self.welcome_message.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the agent.</p>
    pub fn arn(&self) -> &str {
        use std::ops::Deref;
        self.arn.deref()
    }
    /// <p>The unique identifier for the agent.</p>
    pub fn agent_id(&self) -> &str {
        use std::ops::Deref;
        self.agent_id.deref()
    }
    /// <p>The lifecycle state of the agent. Valid values are <code>PREVIEW</code> and <code>PUBLISHED</code>.</p>
    pub fn agent_lifecycle(&self) -> &crate::types::AgentLifecycle {
        &self.agent_lifecycle
    }
    /// <p>The status of the agent.</p>
    pub fn agent_status(&self) -> &crate::types::AgentStatus {
        &self.agent_status
    }
    /// <p>The date and time that the agent was created.</p>
    pub fn created_at(&self) -> &::aws_smithy_types::DateTime {
        &self.created_at
    }
    /// <p>The identity of the user who created the agent.</p>
    pub fn creator(&self) -> &str {
        use std::ops::Deref;
        self.creator.deref()
    }
    /// <p>The custom prompt interface configuration for the agent.</p>
    pub fn custom_prompt_interface(&self) -> ::std::option::Option<&crate::types::CustomPromptInterface> {
        self.custom_prompt_interface.as_ref()
    }
    /// <p>An error message associated with the agent, if applicable.</p>
    pub fn error_message(&self) -> ::std::option::Option<&str> {
        self.error_message.as_deref()
    }
    /// <p>The date and time that the agent was last updated.</p>
    pub fn updated_at(&self) -> &::aws_smithy_types::DateTime {
        &self.updated_at
    }
}
impl ::std::fmt::Debug for Agent {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("Agent");
        formatter.field("spaces", &self.spaces);
        formatter.field("action_connectors", &self.action_connectors);
        formatter.field("description", &self.description);
        formatter.field("icon_id", &self.icon_id);
        formatter.field("name", &self.name);
        formatter.field("starter_prompts", &"*** Sensitive Data Redacted ***");
        formatter.field("welcome_message", &"*** Sensitive Data Redacted ***");
        formatter.field("arn", &self.arn);
        formatter.field("agent_id", &self.agent_id);
        formatter.field("agent_lifecycle", &self.agent_lifecycle);
        formatter.field("agent_status", &self.agent_status);
        formatter.field("created_at", &self.created_at);
        formatter.field("creator", &self.creator);
        formatter.field("custom_prompt_interface", &self.custom_prompt_interface);
        formatter.field("error_message", &self.error_message);
        formatter.field("updated_at", &self.updated_at);
        formatter.finish()
    }
}
impl Agent {
    /// Creates a new builder-style object to manufacture [`Agent`](crate::types::Agent).
    pub fn builder() -> crate::types::builders::AgentBuilder {
        crate::types::builders::AgentBuilder::default()
    }
}

/// A builder for [`Agent`](crate::types::Agent).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct AgentBuilder {
    pub(crate) spaces: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) action_connectors: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) icon_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) starter_prompts: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) welcome_message: ::std::option::Option<::std::string::String>,
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) agent_id: ::std::option::Option<::std::string::String>,
    pub(crate) agent_lifecycle: ::std::option::Option<crate::types::AgentLifecycle>,
    pub(crate) agent_status: ::std::option::Option<crate::types::AgentStatus>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) creator: ::std::option::Option<::std::string::String>,
    pub(crate) custom_prompt_interface: ::std::option::Option<crate::types::CustomPromptInterface>,
    pub(crate) error_message: ::std::option::Option<::std::string::String>,
    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
}
impl AgentBuilder {
    /// Appends an item to `spaces`.
    ///
    /// To override the contents of this collection use [`set_spaces`](Self::set_spaces).
    ///
    /// <p>The Amazon Resource Names (ARNs) of the spaces attached to the agent.</p>
    pub fn spaces(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.spaces.unwrap_or_default();
        v.push(input.into());
        self.spaces = ::std::option::Option::Some(v);
        self
    }
    /// <p>The Amazon Resource Names (ARNs) of the spaces attached to the agent.</p>
    pub fn set_spaces(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.spaces = input;
        self
    }
    /// <p>The Amazon Resource Names (ARNs) of the spaces attached to the agent.</p>
    pub fn get_spaces(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.spaces
    }
    /// Appends an item to `action_connectors`.
    ///
    /// To override the contents of this collection use [`set_action_connectors`](Self::set_action_connectors).
    ///
    /// <p>The Amazon Resource Names (ARNs) of the action connectors attached to the agent.</p>
    pub fn action_connectors(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.action_connectors.unwrap_or_default();
        v.push(input.into());
        self.action_connectors = ::std::option::Option::Some(v);
        self
    }
    /// <p>The Amazon Resource Names (ARNs) of the action connectors attached to the agent.</p>
    pub fn set_action_connectors(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.action_connectors = input;
        self
    }
    /// <p>The Amazon Resource Names (ARNs) of the action connectors attached to the agent.</p>
    pub fn get_action_connectors(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.action_connectors
    }
    /// <p>A description of the agent.</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 description of the agent.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description of the agent.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The icon identifier for the agent.</p>
    pub fn icon_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.icon_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The icon identifier for the agent.</p>
    pub fn set_icon_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.icon_id = input;
        self
    }
    /// <p>The icon identifier for the agent.</p>
    pub fn get_icon_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.icon_id
    }
    /// <p>The name of the agent.</p>
    /// This field is required.
    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 agent.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the agent.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// Appends an item to `starter_prompts`.
    ///
    /// To override the contents of this collection use [`set_starter_prompts`](Self::set_starter_prompts).
    ///
    /// <p>A list of starter prompts that are displayed to users when they begin interacting with the agent.</p>
    pub fn starter_prompts(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.starter_prompts.unwrap_or_default();
        v.push(input.into());
        self.starter_prompts = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of starter prompts that are displayed to users when they begin interacting with the agent.</p>
    pub fn set_starter_prompts(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.starter_prompts = input;
        self
    }
    /// <p>A list of starter prompts that are displayed to users when they begin interacting with the agent.</p>
    pub fn get_starter_prompts(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.starter_prompts
    }
    /// <p>The welcome message that is displayed when a user starts a conversation with the agent.</p>
    pub fn welcome_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.welcome_message = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The welcome message that is displayed when a user starts a conversation with the agent.</p>
    pub fn set_welcome_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.welcome_message = input;
        self
    }
    /// <p>The welcome message that is displayed when a user starts a conversation with the agent.</p>
    pub fn get_welcome_message(&self) -> &::std::option::Option<::std::string::String> {
        &self.welcome_message
    }
    /// <p>The Amazon Resource Name (ARN) of the agent.</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 agent.</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 agent.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>The unique identifier for the agent.</p>
    /// This field is required.
    pub fn agent_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.agent_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier for the agent.</p>
    pub fn set_agent_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.agent_id = input;
        self
    }
    /// <p>The unique identifier for the agent.</p>
    pub fn get_agent_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.agent_id
    }
    /// <p>The lifecycle state of the agent. Valid values are <code>PREVIEW</code> and <code>PUBLISHED</code>.</p>
    /// This field is required.
    pub fn agent_lifecycle(mut self, input: crate::types::AgentLifecycle) -> Self {
        self.agent_lifecycle = ::std::option::Option::Some(input);
        self
    }
    /// <p>The lifecycle state of the agent. Valid values are <code>PREVIEW</code> and <code>PUBLISHED</code>.</p>
    pub fn set_agent_lifecycle(mut self, input: ::std::option::Option<crate::types::AgentLifecycle>) -> Self {
        self.agent_lifecycle = input;
        self
    }
    /// <p>The lifecycle state of the agent. Valid values are <code>PREVIEW</code> and <code>PUBLISHED</code>.</p>
    pub fn get_agent_lifecycle(&self) -> &::std::option::Option<crate::types::AgentLifecycle> {
        &self.agent_lifecycle
    }
    /// <p>The status of the agent.</p>
    /// This field is required.
    pub fn agent_status(mut self, input: crate::types::AgentStatus) -> Self {
        self.agent_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the agent.</p>
    pub fn set_agent_status(mut self, input: ::std::option::Option<crate::types::AgentStatus>) -> Self {
        self.agent_status = input;
        self
    }
    /// <p>The status of the agent.</p>
    pub fn get_agent_status(&self) -> &::std::option::Option<crate::types::AgentStatus> {
        &self.agent_status
    }
    /// <p>The date and time that the agent was created.</p>
    /// This field is required.
    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 that the agent 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 date and time that the agent was created.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>The identity of the user who created the agent.</p>
    /// This field is required.
    pub fn creator(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.creator = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identity of the user who created the agent.</p>
    pub fn set_creator(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.creator = input;
        self
    }
    /// <p>The identity of the user who created the agent.</p>
    pub fn get_creator(&self) -> &::std::option::Option<::std::string::String> {
        &self.creator
    }
    /// <p>The custom prompt interface configuration for the agent.</p>
    pub fn custom_prompt_interface(mut self, input: crate::types::CustomPromptInterface) -> Self {
        self.custom_prompt_interface = ::std::option::Option::Some(input);
        self
    }
    /// <p>The custom prompt interface configuration for the agent.</p>
    pub fn set_custom_prompt_interface(mut self, input: ::std::option::Option<crate::types::CustomPromptInterface>) -> Self {
        self.custom_prompt_interface = input;
        self
    }
    /// <p>The custom prompt interface configuration for the agent.</p>
    pub fn get_custom_prompt_interface(&self) -> &::std::option::Option<crate::types::CustomPromptInterface> {
        &self.custom_prompt_interface
    }
    /// <p>An error message associated with the agent, if applicable.</p>
    pub fn error_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.error_message = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>An error message associated with the agent, if applicable.</p>
    pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.error_message = input;
        self
    }
    /// <p>An error message associated with the agent, if applicable.</p>
    pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
        &self.error_message
    }
    /// <p>The date and time that the agent was last updated.</p>
    /// This field is required.
    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 that the agent was last updated.</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 that the agent was last updated.</p>
    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.updated_at
    }
    /// Consumes the builder and constructs a [`Agent`](crate::types::Agent).
    /// This method will fail if any of the following fields are not set:
    /// - [`name`](crate::types::builders::AgentBuilder::name)
    /// - [`arn`](crate::types::builders::AgentBuilder::arn)
    /// - [`agent_id`](crate::types::builders::AgentBuilder::agent_id)
    /// - [`agent_lifecycle`](crate::types::builders::AgentBuilder::agent_lifecycle)
    /// - [`agent_status`](crate::types::builders::AgentBuilder::agent_status)
    /// - [`created_at`](crate::types::builders::AgentBuilder::created_at)
    /// - [`creator`](crate::types::builders::AgentBuilder::creator)
    /// - [`updated_at`](crate::types::builders::AgentBuilder::updated_at)
    pub fn build(self) -> ::std::result::Result<crate::types::Agent, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::Agent {
            spaces: self.spaces,
            action_connectors: self.action_connectors,
            description: self.description,
            icon_id: self.icon_id,
            name: self.name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "name",
                    "name was not specified but it is required when building Agent",
                )
            })?,
            starter_prompts: self.starter_prompts,
            welcome_message: self.welcome_message,
            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 Agent")
            })?,
            agent_id: self.agent_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "agent_id",
                    "agent_id was not specified but it is required when building Agent",
                )
            })?,
            agent_lifecycle: self.agent_lifecycle.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "agent_lifecycle",
                    "agent_lifecycle was not specified but it is required when building Agent",
                )
            })?,
            agent_status: self.agent_status.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "agent_status",
                    "agent_status was not specified but it is required when building Agent",
                )
            })?,
            created_at: self.created_at.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "created_at",
                    "created_at was not specified but it is required when building Agent",
                )
            })?,
            creator: self.creator.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "creator",
                    "creator was not specified but it is required when building Agent",
                )
            })?,
            custom_prompt_interface: self.custom_prompt_interface,
            error_message: self.error_message,
            updated_at: self.updated_at.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "updated_at",
                    "updated_at was not specified but it is required when building Agent",
                )
            })?,
        })
    }
}
impl ::std::fmt::Debug for AgentBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("AgentBuilder");
        formatter.field("spaces", &self.spaces);
        formatter.field("action_connectors", &self.action_connectors);
        formatter.field("description", &self.description);
        formatter.field("icon_id", &self.icon_id);
        formatter.field("name", &self.name);
        formatter.field("starter_prompts", &"*** Sensitive Data Redacted ***");
        formatter.field("welcome_message", &"*** Sensitive Data Redacted ***");
        formatter.field("arn", &self.arn);
        formatter.field("agent_id", &self.agent_id);
        formatter.field("agent_lifecycle", &self.agent_lifecycle);
        formatter.field("agent_status", &self.agent_status);
        formatter.field("created_at", &self.created_at);
        formatter.field("creator", &self.creator);
        formatter.field("custom_prompt_interface", &self.custom_prompt_interface);
        formatter.field("error_message", &self.error_message);
        formatter.field("updated_at", &self.updated_at);
        formatter.finish()
    }
}