aws-sdk-databrew 1.98.0

AWS SDK for AWS Glue DataBrew
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Represents all of the attributes of a DataBrew project.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Project {
    /// <p>The ID of the Amazon Web Services account that owns the project.</p>
    pub account_id: ::std::option::Option<::std::string::String>,
    /// <p>The date and time that the project was created.</p>
    pub create_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The Amazon Resource Name (ARN) of the user who crated the project.</p>
    pub created_by: ::std::option::Option<::std::string::String>,
    /// <p>The dataset that the project is to act upon.</p>
    pub dataset_name: ::std::option::Option<::std::string::String>,
    /// <p>The last modification date and time for the project.</p>
    pub last_modified_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The Amazon Resource Name (ARN) of the user who last modified the project.</p>
    pub last_modified_by: ::std::option::Option<::std::string::String>,
    /// <p>The unique name of a project.</p>
    pub name: ::std::string::String,
    /// <p>The name of a recipe that will be developed during a project session.</p>
    pub recipe_name: ::std::string::String,
    /// <p>The Amazon Resource Name (ARN) for the project.</p>
    pub resource_arn: ::std::option::Option<::std::string::String>,
    /// <p>The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.</p>
    pub sample: ::std::option::Option<crate::types::Sample>,
    /// <p>Metadata tags that have been applied to the project.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>The Amazon Resource Name (ARN) of the role that will be assumed for this project.</p>
    pub role_arn: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the user that opened the project for use.</p>
    pub opened_by: ::std::option::Option<::std::string::String>,
    /// <p>The date and time when the project was opened.</p>
    pub open_date: ::std::option::Option<::aws_smithy_types::DateTime>,
}
impl Project {
    /// <p>The ID of the Amazon Web Services account that owns the project.</p>
    pub fn account_id(&self) -> ::std::option::Option<&str> {
        self.account_id.as_deref()
    }
    /// <p>The date and time that the project was created.</p>
    pub fn create_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.create_date.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the user who crated the project.</p>
    pub fn created_by(&self) -> ::std::option::Option<&str> {
        self.created_by.as_deref()
    }
    /// <p>The dataset that the project is to act upon.</p>
    pub fn dataset_name(&self) -> ::std::option::Option<&str> {
        self.dataset_name.as_deref()
    }
    /// <p>The last modification date and time for the project.</p>
    pub fn last_modified_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_modified_date.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the user who last modified the project.</p>
    pub fn last_modified_by(&self) -> ::std::option::Option<&str> {
        self.last_modified_by.as_deref()
    }
    /// <p>The unique name of a project.</p>
    pub fn name(&self) -> &str {
        use std::ops::Deref;
        self.name.deref()
    }
    /// <p>The name of a recipe that will be developed during a project session.</p>
    pub fn recipe_name(&self) -> &str {
        use std::ops::Deref;
        self.recipe_name.deref()
    }
    /// <p>The Amazon Resource Name (ARN) for the project.</p>
    pub fn resource_arn(&self) -> ::std::option::Option<&str> {
        self.resource_arn.as_deref()
    }
    /// <p>The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.</p>
    pub fn sample(&self) -> ::std::option::Option<&crate::types::Sample> {
        self.sample.as_ref()
    }
    /// <p>Metadata tags that have been applied to the project.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the role that will be assumed for this project.</p>
    pub fn role_arn(&self) -> ::std::option::Option<&str> {
        self.role_arn.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the user that opened the project for use.</p>
    pub fn opened_by(&self) -> ::std::option::Option<&str> {
        self.opened_by.as_deref()
    }
    /// <p>The date and time when the project was opened.</p>
    pub fn open_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.open_date.as_ref()
    }
}
impl Project {
    /// Creates a new builder-style object to manufacture [`Project`](crate::types::Project).
    pub fn builder() -> crate::types::builders::ProjectBuilder {
        crate::types::builders::ProjectBuilder::default()
    }
}

/// A builder for [`Project`](crate::types::Project).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ProjectBuilder {
    pub(crate) account_id: ::std::option::Option<::std::string::String>,
    pub(crate) create_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) created_by: ::std::option::Option<::std::string::String>,
    pub(crate) dataset_name: ::std::option::Option<::std::string::String>,
    pub(crate) last_modified_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_modified_by: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) recipe_name: ::std::option::Option<::std::string::String>,
    pub(crate) resource_arn: ::std::option::Option<::std::string::String>,
    pub(crate) sample: ::std::option::Option<crate::types::Sample>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) opened_by: ::std::option::Option<::std::string::String>,
    pub(crate) open_date: ::std::option::Option<::aws_smithy_types::DateTime>,
}
impl ProjectBuilder {
    /// <p>The ID of the Amazon Web Services account that owns the project.</p>
    pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.account_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the Amazon Web Services account that owns the project.</p>
    pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.account_id = input;
        self
    }
    /// <p>The ID of the Amazon Web Services account that owns the project.</p>
    pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.account_id
    }
    /// <p>The date and time that the project was created.</p>
    pub fn create_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.create_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time that the project was created.</p>
    pub fn set_create_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.create_date = input;
        self
    }
    /// <p>The date and time that the project was created.</p>
    pub fn get_create_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.create_date
    }
    /// <p>The Amazon Resource Name (ARN) of the user who crated the project.</p>
    pub fn created_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.created_by = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the user who crated the project.</p>
    pub fn set_created_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.created_by = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the user who crated the project.</p>
    pub fn get_created_by(&self) -> &::std::option::Option<::std::string::String> {
        &self.created_by
    }
    /// <p>The dataset that the project is to act upon.</p>
    pub fn dataset_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.dataset_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The dataset that the project is to act upon.</p>
    pub fn set_dataset_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.dataset_name = input;
        self
    }
    /// <p>The dataset that the project is to act upon.</p>
    pub fn get_dataset_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.dataset_name
    }
    /// <p>The last modification date and time for the project.</p>
    pub fn last_modified_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_modified_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The last modification date and time for the project.</p>
    pub fn set_last_modified_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_modified_date = input;
        self
    }
    /// <p>The last modification date and time for the project.</p>
    pub fn get_last_modified_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_modified_date
    }
    /// <p>The Amazon Resource Name (ARN) of the user who last modified the project.</p>
    pub fn last_modified_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.last_modified_by = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the user who last modified the project.</p>
    pub fn set_last_modified_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.last_modified_by = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the user who last modified the project.</p>
    pub fn get_last_modified_by(&self) -> &::std::option::Option<::std::string::String> {
        &self.last_modified_by
    }
    /// <p>The unique name of a project.</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 unique name of a project.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The unique name of a project.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The name of a recipe that will be developed during a project session.</p>
    /// This field is required.
    pub fn recipe_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.recipe_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of a recipe that will be developed during a project session.</p>
    pub fn set_recipe_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.recipe_name = input;
        self
    }
    /// <p>The name of a recipe that will be developed during a project session.</p>
    pub fn get_recipe_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.recipe_name
    }
    /// <p>The Amazon Resource Name (ARN) for the project.</p>
    pub fn resource_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.resource_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) for the project.</p>
    pub fn set_resource_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.resource_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) for the project.</p>
    pub fn get_resource_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.resource_arn
    }
    /// <p>The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.</p>
    pub fn sample(mut self, input: crate::types::Sample) -> Self {
        self.sample = ::std::option::Option::Some(input);
        self
    }
    /// <p>The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.</p>
    pub fn set_sample(mut self, input: ::std::option::Option<crate::types::Sample>) -> Self {
        self.sample = input;
        self
    }
    /// <p>The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.</p>
    pub fn get_sample(&self) -> &::std::option::Option<crate::types::Sample> {
        &self.sample
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Metadata tags that have been applied to the project.</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>Metadata tags that have been applied to the project.</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>Metadata tags that have been applied to the project.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// <p>The Amazon Resource Name (ARN) of the role that will be assumed for this project.</p>
    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the role that will be assumed for this project.</p>
    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.role_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the role that will be assumed for this project.</p>
    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.role_arn
    }
    /// <p>The Amazon Resource Name (ARN) of the user that opened the project for use.</p>
    pub fn opened_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.opened_by = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the user that opened the project for use.</p>
    pub fn set_opened_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.opened_by = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the user that opened the project for use.</p>
    pub fn get_opened_by(&self) -> &::std::option::Option<::std::string::String> {
        &self.opened_by
    }
    /// <p>The date and time when the project was opened.</p>
    pub fn open_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.open_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time when the project was opened.</p>
    pub fn set_open_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.open_date = input;
        self
    }
    /// <p>The date and time when the project was opened.</p>
    pub fn get_open_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.open_date
    }
    /// Consumes the builder and constructs a [`Project`](crate::types::Project).
    /// This method will fail if any of the following fields are not set:
    /// - [`name`](crate::types::builders::ProjectBuilder::name)
    /// - [`recipe_name`](crate::types::builders::ProjectBuilder::recipe_name)
    pub fn build(self) -> ::std::result::Result<crate::types::Project, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::Project {
            account_id: self.account_id,
            create_date: self.create_date,
            created_by: self.created_by,
            dataset_name: self.dataset_name,
            last_modified_date: self.last_modified_date,
            last_modified_by: self.last_modified_by,
            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 Project",
                )
            })?,
            recipe_name: self.recipe_name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "recipe_name",
                    "recipe_name was not specified but it is required when building Project",
                )
            })?,
            resource_arn: self.resource_arn,
            sample: self.sample,
            tags: self.tags,
            role_arn: self.role_arn,
            opened_by: self.opened_by,
            open_date: self.open_date,
        })
    }
}