aws-sdk-personalize 1.106.0

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

/// <p>Provides metadata for a dataset.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Dataset {
    /// <p>The name of the dataset.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the dataset that you want metadata for.</p>
    pub dataset_arn: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the dataset group.</p>
    pub dataset_group_arn: ::std::option::Option<::std::string::String>,
    /// <p>One of the following values:</p>
    /// <ul>
    /// <li>
    /// <p>Interactions</p></li>
    /// <li>
    /// <p>Items</p></li>
    /// <li>
    /// <p>Users</p></li>
    /// <li>
    /// <p>Actions</p></li>
    /// <li>
    /// <p>Action_Interactions</p></li>
    /// </ul>
    pub dataset_type: ::std::option::Option<::std::string::String>,
    /// <p>The ARN of the associated schema.</p>
    pub schema_arn: ::std::option::Option<::std::string::String>,
    /// <p>The status of the dataset.</p>
    /// <p>A dataset can be in one of the following states:</p>
    /// <ul>
    /// <li>
    /// <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p></li>
    /// <li>
    /// <p>DELETE PENDING &gt; DELETE IN_PROGRESS</p></li>
    /// </ul>
    pub status: ::std::option::Option<::std::string::String>,
    /// <p>The creation date and time (in Unix time) of the dataset.</p>
    pub creation_date_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A time stamp that shows when the dataset was updated.</p>
    pub last_updated_date_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Describes the latest update to the dataset.</p>
    pub latest_dataset_update: ::std::option::Option<crate::types::DatasetUpdateSummary>,
    /// <p>The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the <code>PutActionInteractions</code> API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.</p>
    pub tracking_id: ::std::option::Option<::std::string::String>,
}
impl Dataset {
    /// <p>The name of the dataset.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset that you want metadata for.</p>
    pub fn dataset_arn(&self) -> ::std::option::Option<&str> {
        self.dataset_arn.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset group.</p>
    pub fn dataset_group_arn(&self) -> ::std::option::Option<&str> {
        self.dataset_group_arn.as_deref()
    }
    /// <p>One of the following values:</p>
    /// <ul>
    /// <li>
    /// <p>Interactions</p></li>
    /// <li>
    /// <p>Items</p></li>
    /// <li>
    /// <p>Users</p></li>
    /// <li>
    /// <p>Actions</p></li>
    /// <li>
    /// <p>Action_Interactions</p></li>
    /// </ul>
    pub fn dataset_type(&self) -> ::std::option::Option<&str> {
        self.dataset_type.as_deref()
    }
    /// <p>The ARN of the associated schema.</p>
    pub fn schema_arn(&self) -> ::std::option::Option<&str> {
        self.schema_arn.as_deref()
    }
    /// <p>The status of the dataset.</p>
    /// <p>A dataset can be in one of the following states:</p>
    /// <ul>
    /// <li>
    /// <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p></li>
    /// <li>
    /// <p>DELETE PENDING &gt; DELETE IN_PROGRESS</p></li>
    /// </ul>
    pub fn status(&self) -> ::std::option::Option<&str> {
        self.status.as_deref()
    }
    /// <p>The creation date and time (in Unix time) of the dataset.</p>
    pub fn creation_date_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_date_time.as_ref()
    }
    /// <p>A time stamp that shows when the dataset was updated.</p>
    pub fn last_updated_date_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_updated_date_time.as_ref()
    }
    /// <p>Describes the latest update to the dataset.</p>
    pub fn latest_dataset_update(&self) -> ::std::option::Option<&crate::types::DatasetUpdateSummary> {
        self.latest_dataset_update.as_ref()
    }
    /// <p>The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the <code>PutActionInteractions</code> API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.</p>
    pub fn tracking_id(&self) -> ::std::option::Option<&str> {
        self.tracking_id.as_deref()
    }
}
impl Dataset {
    /// Creates a new builder-style object to manufacture [`Dataset`](crate::types::Dataset).
    pub fn builder() -> crate::types::builders::DatasetBuilder {
        crate::types::builders::DatasetBuilder::default()
    }
}

/// A builder for [`Dataset`](crate::types::Dataset).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DatasetBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) dataset_arn: ::std::option::Option<::std::string::String>,
    pub(crate) dataset_group_arn: ::std::option::Option<::std::string::String>,
    pub(crate) dataset_type: ::std::option::Option<::std::string::String>,
    pub(crate) schema_arn: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<::std::string::String>,
    pub(crate) creation_date_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_updated_date_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) latest_dataset_update: ::std::option::Option<crate::types::DatasetUpdateSummary>,
    pub(crate) tracking_id: ::std::option::Option<::std::string::String>,
}
impl DatasetBuilder {
    /// <p>The name of the dataset.</p>
    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 dataset.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the dataset.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset that you want metadata for.</p>
    pub fn dataset_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.dataset_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset that you want metadata for.</p>
    pub fn set_dataset_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.dataset_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset that you want metadata for.</p>
    pub fn get_dataset_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.dataset_arn
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset group.</p>
    pub fn dataset_group_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.dataset_group_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset group.</p>
    pub fn set_dataset_group_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.dataset_group_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the dataset group.</p>
    pub fn get_dataset_group_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.dataset_group_arn
    }
    /// <p>One of the following values:</p>
    /// <ul>
    /// <li>
    /// <p>Interactions</p></li>
    /// <li>
    /// <p>Items</p></li>
    /// <li>
    /// <p>Users</p></li>
    /// <li>
    /// <p>Actions</p></li>
    /// <li>
    /// <p>Action_Interactions</p></li>
    /// </ul>
    pub fn dataset_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.dataset_type = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>One of the following values:</p>
    /// <ul>
    /// <li>
    /// <p>Interactions</p></li>
    /// <li>
    /// <p>Items</p></li>
    /// <li>
    /// <p>Users</p></li>
    /// <li>
    /// <p>Actions</p></li>
    /// <li>
    /// <p>Action_Interactions</p></li>
    /// </ul>
    pub fn set_dataset_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.dataset_type = input;
        self
    }
    /// <p>One of the following values:</p>
    /// <ul>
    /// <li>
    /// <p>Interactions</p></li>
    /// <li>
    /// <p>Items</p></li>
    /// <li>
    /// <p>Users</p></li>
    /// <li>
    /// <p>Actions</p></li>
    /// <li>
    /// <p>Action_Interactions</p></li>
    /// </ul>
    pub fn get_dataset_type(&self) -> &::std::option::Option<::std::string::String> {
        &self.dataset_type
    }
    /// <p>The ARN of the associated schema.</p>
    pub fn schema_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.schema_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the associated schema.</p>
    pub fn set_schema_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.schema_arn = input;
        self
    }
    /// <p>The ARN of the associated schema.</p>
    pub fn get_schema_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.schema_arn
    }
    /// <p>The status of the dataset.</p>
    /// <p>A dataset can be in one of the following states:</p>
    /// <ul>
    /// <li>
    /// <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p></li>
    /// <li>
    /// <p>DELETE PENDING &gt; DELETE IN_PROGRESS</p></li>
    /// </ul>
    pub fn status(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.status = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The status of the dataset.</p>
    /// <p>A dataset can be in one of the following states:</p>
    /// <ul>
    /// <li>
    /// <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p></li>
    /// <li>
    /// <p>DELETE PENDING &gt; DELETE IN_PROGRESS</p></li>
    /// </ul>
    pub fn set_status(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the dataset.</p>
    /// <p>A dataset can be in one of the following states:</p>
    /// <ul>
    /// <li>
    /// <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p></li>
    /// <li>
    /// <p>DELETE PENDING &gt; DELETE IN_PROGRESS</p></li>
    /// </ul>
    pub fn get_status(&self) -> &::std::option::Option<::std::string::String> {
        &self.status
    }
    /// <p>The creation date and time (in Unix time) of the dataset.</p>
    pub fn creation_date_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_date_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The creation date and time (in Unix time) of the dataset.</p>
    pub fn set_creation_date_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_date_time = input;
        self
    }
    /// <p>The creation date and time (in Unix time) of the dataset.</p>
    pub fn get_creation_date_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_date_time
    }
    /// <p>A time stamp that shows when the dataset was updated.</p>
    pub fn last_updated_date_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_updated_date_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>A time stamp that shows when the dataset was updated.</p>
    pub fn set_last_updated_date_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_updated_date_time = input;
        self
    }
    /// <p>A time stamp that shows when the dataset was updated.</p>
    pub fn get_last_updated_date_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_updated_date_time
    }
    /// <p>Describes the latest update to the dataset.</p>
    pub fn latest_dataset_update(mut self, input: crate::types::DatasetUpdateSummary) -> Self {
        self.latest_dataset_update = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes the latest update to the dataset.</p>
    pub fn set_latest_dataset_update(mut self, input: ::std::option::Option<crate::types::DatasetUpdateSummary>) -> Self {
        self.latest_dataset_update = input;
        self
    }
    /// <p>Describes the latest update to the dataset.</p>
    pub fn get_latest_dataset_update(&self) -> &::std::option::Option<crate::types::DatasetUpdateSummary> {
        &self.latest_dataset_update
    }
    /// <p>The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the <code>PutActionInteractions</code> API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.</p>
    pub fn tracking_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.tracking_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the <code>PutActionInteractions</code> API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.</p>
    pub fn set_tracking_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.tracking_id = input;
        self
    }
    /// <p>The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the <code>PutActionInteractions</code> API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.</p>
    pub fn get_tracking_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.tracking_id
    }
    /// Consumes the builder and constructs a [`Dataset`](crate::types::Dataset).
    pub fn build(self) -> crate::types::Dataset {
        crate::types::Dataset {
            name: self.name,
            dataset_arn: self.dataset_arn,
            dataset_group_arn: self.dataset_group_arn,
            dataset_type: self.dataset_type,
            schema_arn: self.schema_arn,
            status: self.status,
            creation_date_time: self.creation_date_time,
            last_updated_date_time: self.last_updated_date_time,
            latest_dataset_update: self.latest_dataset_update,
            tracking_id: self.tracking_id,
        }
    }
}