aws-sdk-quicksight 1.145.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 CreateKnowledgeBaseInput {
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub aws_account_id: ::std::option::Option<::std::string::String>,
    /// <p>The unique identifier for the knowledge base.</p>
    pub knowledge_base_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the knowledge base.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the data source for the knowledge base.</p>
    pub data_source_arn: ::std::option::Option<::std::string::String>,
    /// <p>The configuration settings for a knowledge base.</p>
    pub knowledge_base_configuration: ::std::option::Option<crate::types::KnowledgeBaseConfiguration>,
    /// <p>A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.</p>
    pub permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
    /// <p>The configuration for media extraction from knowledge base documents.</p>
    pub media_extraction_configuration: ::std::option::Option<crate::types::MediaExtractionConfiguration>,
    /// <p>The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.</p>
    pub access_control_configuration: ::std::option::Option<crate::types::AccessControlConfiguration>,
    /// <p>The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the <code>Permissions</code> field. If you don't specify a primary owner, the knowledge base is created without one.</p>
    pub primary_owner_arn: ::std::option::Option<::std::string::String>,
    /// <p>The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateKnowledgeBaseInput {
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
        self.aws_account_id.as_deref()
    }
    /// <p>The unique identifier for the knowledge base.</p>
    pub fn knowledge_base_id(&self) -> ::std::option::Option<&str> {
        self.knowledge_base_id.as_deref()
    }
    /// <p>The name of the knowledge base.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the data source for the knowledge base.</p>
    pub fn data_source_arn(&self) -> ::std::option::Option<&str> {
        self.data_source_arn.as_deref()
    }
    /// <p>The configuration settings for a knowledge base.</p>
    pub fn knowledge_base_configuration(&self) -> ::std::option::Option<&crate::types::KnowledgeBaseConfiguration> {
        self.knowledge_base_configuration.as_ref()
    }
    /// <p>A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.</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 `.permissions.is_none()`.
    pub fn permissions(&self) -> &[crate::types::ResourcePermission] {
        self.permissions.as_deref().unwrap_or_default()
    }
    /// <p>The configuration for media extraction from knowledge base documents.</p>
    pub fn media_extraction_configuration(&self) -> ::std::option::Option<&crate::types::MediaExtractionConfiguration> {
        self.media_extraction_configuration.as_ref()
    }
    /// <p>The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.</p>
    pub fn access_control_configuration(&self) -> ::std::option::Option<&crate::types::AccessControlConfiguration> {
        self.access_control_configuration.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the <code>Permissions</code> field. If you don't specify a primary owner, the knowledge base is created without one.</p>
    pub fn primary_owner_arn(&self) -> ::std::option::Option<&str> {
        self.primary_owner_arn.as_deref()
    }
    /// <p>The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.</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 `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
}
impl ::std::fmt::Debug for CreateKnowledgeBaseInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateKnowledgeBaseInput");
        formatter.field("aws_account_id", &self.aws_account_id);
        formatter.field("knowledge_base_id", &self.knowledge_base_id);
        formatter.field("name", &self.name);
        formatter.field("data_source_arn", &self.data_source_arn);
        formatter.field("knowledge_base_configuration", &"*** Sensitive Data Redacted ***");
        formatter.field("description", &self.description);
        formatter.field("permissions", &self.permissions);
        formatter.field("media_extraction_configuration", &self.media_extraction_configuration);
        formatter.field("access_control_configuration", &self.access_control_configuration);
        formatter.field("primary_owner_arn", &self.primary_owner_arn);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}
impl CreateKnowledgeBaseInput {
    /// Creates a new builder-style object to manufacture [`CreateKnowledgeBaseInput`](crate::operation::create_knowledge_base::CreateKnowledgeBaseInput).
    pub fn builder() -> crate::operation::create_knowledge_base::builders::CreateKnowledgeBaseInputBuilder {
        crate::operation::create_knowledge_base::builders::CreateKnowledgeBaseInputBuilder::default()
    }
}

/// A builder for [`CreateKnowledgeBaseInput`](crate::operation::create_knowledge_base::CreateKnowledgeBaseInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct CreateKnowledgeBaseInputBuilder {
    pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
    pub(crate) knowledge_base_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) data_source_arn: ::std::option::Option<::std::string::String>,
    pub(crate) knowledge_base_configuration: ::std::option::Option<crate::types::KnowledgeBaseConfiguration>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
    pub(crate) media_extraction_configuration: ::std::option::Option<crate::types::MediaExtractionConfiguration>,
    pub(crate) access_control_configuration: ::std::option::Option<crate::types::AccessControlConfiguration>,
    pub(crate) primary_owner_arn: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateKnowledgeBaseInputBuilder {
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    /// This field is required.
    pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.aws_account_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.aws_account_id = input;
        self
    }
    /// <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
    pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.aws_account_id
    }
    /// <p>The unique identifier for the knowledge base.</p>
    /// This field is required.
    pub fn knowledge_base_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.knowledge_base_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier for the knowledge base.</p>
    pub fn set_knowledge_base_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.knowledge_base_id = input;
        self
    }
    /// <p>The unique identifier for the knowledge base.</p>
    pub fn get_knowledge_base_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.knowledge_base_id
    }
    /// <p>The name of the knowledge base.</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 knowledge base.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the knowledge base.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The Amazon Resource Name (ARN) of the data source for the knowledge base.</p>
    /// This field is required.
    pub fn data_source_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.data_source_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the data source for the knowledge base.</p>
    pub fn set_data_source_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.data_source_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the data source for the knowledge base.</p>
    pub fn get_data_source_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.data_source_arn
    }
    /// <p>The configuration settings for a knowledge base.</p>
    /// This field is required.
    pub fn knowledge_base_configuration(mut self, input: crate::types::KnowledgeBaseConfiguration) -> Self {
        self.knowledge_base_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration settings for a knowledge base.</p>
    pub fn set_knowledge_base_configuration(mut self, input: ::std::option::Option<crate::types::KnowledgeBaseConfiguration>) -> Self {
        self.knowledge_base_configuration = input;
        self
    }
    /// <p>The configuration settings for a knowledge base.</p>
    pub fn get_knowledge_base_configuration(&self) -> &::std::option::Option<crate::types::KnowledgeBaseConfiguration> {
        &self.knowledge_base_configuration
    }
    /// <p>A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.</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 for the knowledge base. If you don't specify a description, the knowledge base is created without one.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// Appends an item to `permissions`.
    ///
    /// To override the contents of this collection use [`set_permissions`](Self::set_permissions).
    ///
    /// <p>A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.</p>
    pub fn permissions(mut self, input: crate::types::ResourcePermission) -> Self {
        let mut v = self.permissions.unwrap_or_default();
        v.push(input);
        self.permissions = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.</p>
    pub fn set_permissions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>) -> Self {
        self.permissions = input;
        self
    }
    /// <p>A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.</p>
    pub fn get_permissions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>> {
        &self.permissions
    }
    /// <p>The configuration for media extraction from knowledge base documents.</p>
    pub fn media_extraction_configuration(mut self, input: crate::types::MediaExtractionConfiguration) -> Self {
        self.media_extraction_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration for media extraction from knowledge base documents.</p>
    pub fn set_media_extraction_configuration(mut self, input: ::std::option::Option<crate::types::MediaExtractionConfiguration>) -> Self {
        self.media_extraction_configuration = input;
        self
    }
    /// <p>The configuration for media extraction from knowledge base documents.</p>
    pub fn get_media_extraction_configuration(&self) -> &::std::option::Option<crate::types::MediaExtractionConfiguration> {
        &self.media_extraction_configuration
    }
    /// <p>The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.</p>
    pub fn access_control_configuration(mut self, input: crate::types::AccessControlConfiguration) -> Self {
        self.access_control_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.</p>
    pub fn set_access_control_configuration(mut self, input: ::std::option::Option<crate::types::AccessControlConfiguration>) -> Self {
        self.access_control_configuration = input;
        self
    }
    /// <p>The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.</p>
    pub fn get_access_control_configuration(&self) -> &::std::option::Option<crate::types::AccessControlConfiguration> {
        &self.access_control_configuration
    }
    /// <p>The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the <code>Permissions</code> field. If you don't specify a primary owner, the knowledge base is created without one.</p>
    pub fn primary_owner_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.primary_owner_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the <code>Permissions</code> field. If you don't specify a primary owner, the knowledge base is created without one.</p>
    pub fn set_primary_owner_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.primary_owner_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the <code>Permissions</code> field. If you don't specify a primary owner, the knowledge base is created without one.</p>
    pub fn get_primary_owner_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.primary_owner_arn
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`CreateKnowledgeBaseInput`](crate::operation::create_knowledge_base::CreateKnowledgeBaseInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_knowledge_base::CreateKnowledgeBaseInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::create_knowledge_base::CreateKnowledgeBaseInput {
            aws_account_id: self.aws_account_id,
            knowledge_base_id: self.knowledge_base_id,
            name: self.name,
            data_source_arn: self.data_source_arn,
            knowledge_base_configuration: self.knowledge_base_configuration,
            description: self.description,
            permissions: self.permissions,
            media_extraction_configuration: self.media_extraction_configuration,
            access_control_configuration: self.access_control_configuration,
            primary_owner_arn: self.primary_owner_arn,
            tags: self.tags,
        })
    }
}
impl ::std::fmt::Debug for CreateKnowledgeBaseInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateKnowledgeBaseInputBuilder");
        formatter.field("aws_account_id", &self.aws_account_id);
        formatter.field("knowledge_base_id", &self.knowledge_base_id);
        formatter.field("name", &self.name);
        formatter.field("data_source_arn", &self.data_source_arn);
        formatter.field("knowledge_base_configuration", &"*** Sensitive Data Redacted ***");
        formatter.field("description", &self.description);
        formatter.field("permissions", &self.permissions);
        formatter.field("media_extraction_configuration", &self.media_extraction_configuration);
        formatter.field("access_control_configuration", &self.access_control_configuration);
        formatter.field("primary_owner_arn", &self.primary_owner_arn);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}