aws_sdk_machinelearning/types/

_batch_prediction.rs

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

/// <p>Represents the output of a <code>GetBatchPrediction</code> operation.</p>
/// <p>The content consists of the detailed metadata, the status, and the data file information of a <code>Batch Prediction</code>.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct BatchPrediction {
    /// <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
    pub batch_prediction_id: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
    pub ml_model_id: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
    pub batch_prediction_data_source_id: ::std::option::Option<::std::string::String>,
    /// <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
    pub input_data_location_s3: ::std::option::Option<::std::string::String>,
    /// <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
    pub created_by_iam_user: ::std::option::Option<::std::string::String>,
    /// <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
    pub last_updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.</p></li>
    /// <li>
    /// <p><code>INPROGRESS</code> - The process is underway.</p></li>
    /// <li>
    /// <p><code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p></li>
    /// <li>
    /// <p><code>COMPLETED</code> - The batch prediction process completed successfully.</p></li>
    /// <li>
    /// <p><code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p></li>
    /// </ul>
    pub status: ::std::option::Option<crate::types::EntityStatus>,
    /// <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
    pub output_uri: ::std::option::Option<::std::string::String>,
    /// <p>A description of the most recent details about processing the batch prediction request.</p>
    pub message: ::std::option::Option<::std::string::String>,
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub compute_time: ::std::option::Option<i64>,
    /// <p>A timestamp represented in epoch time.</p>
    pub finished_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A timestamp represented in epoch time.</p>
    pub started_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub total_record_count: ::std::option::Option<i64>,
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub invalid_record_count: ::std::option::Option<i64>,
}
impl BatchPrediction {
    /// <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
    pub fn batch_prediction_id(&self) -> ::std::option::Option<&str> {
        self.batch_prediction_id.as_deref()
    }
    /// <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
    pub fn ml_model_id(&self) -> ::std::option::Option<&str> {
        self.ml_model_id.as_deref()
    }
    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
    pub fn batch_prediction_data_source_id(&self) -> ::std::option::Option<&str> {
        self.batch_prediction_data_source_id.as_deref()
    }
    /// <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
    pub fn input_data_location_s3(&self) -> ::std::option::Option<&str> {
        self.input_data_location_s3.as_deref()
    }
    /// <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
    pub fn created_by_iam_user(&self) -> ::std::option::Option<&str> {
        self.created_by_iam_user.as_deref()
    }
    /// <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_at.as_ref()
    }
    /// <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
    pub fn last_updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_updated_at.as_ref()
    }
    /// <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.</p></li>
    /// <li>
    /// <p><code>INPROGRESS</code> - The process is underway.</p></li>
    /// <li>
    /// <p><code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p></li>
    /// <li>
    /// <p><code>COMPLETED</code> - The batch prediction process completed successfully.</p></li>
    /// <li>
    /// <p><code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p></li>
    /// </ul>
    pub fn status(&self) -> ::std::option::Option<&crate::types::EntityStatus> {
        self.status.as_ref()
    }
    /// <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
    pub fn output_uri(&self) -> ::std::option::Option<&str> {
        self.output_uri.as_deref()
    }
    /// <p>A description of the most recent details about processing the batch prediction request.</p>
    pub fn message(&self) -> ::std::option::Option<&str> {
        self.message.as_deref()
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn compute_time(&self) -> ::std::option::Option<i64> {
        self.compute_time
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn finished_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.finished_at.as_ref()
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn started_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.started_at.as_ref()
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn total_record_count(&self) -> ::std::option::Option<i64> {
        self.total_record_count
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn invalid_record_count(&self) -> ::std::option::Option<i64> {
        self.invalid_record_count
    }
}
impl BatchPrediction {
    /// Creates a new builder-style object to manufacture [`BatchPrediction`](crate::types::BatchPrediction).
    pub fn builder() -> crate::types::builders::BatchPredictionBuilder {
        crate::types::builders::BatchPredictionBuilder::default()
    }
}

/// A builder for [`BatchPrediction`](crate::types::BatchPrediction).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct BatchPredictionBuilder {
    pub(crate) batch_prediction_id: ::std::option::Option<::std::string::String>,
    pub(crate) ml_model_id: ::std::option::Option<::std::string::String>,
    pub(crate) batch_prediction_data_source_id: ::std::option::Option<::std::string::String>,
    pub(crate) input_data_location_s3: ::std::option::Option<::std::string::String>,
    pub(crate) created_by_iam_user: ::std::option::Option<::std::string::String>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::EntityStatus>,
    pub(crate) output_uri: ::std::option::Option<::std::string::String>,
    pub(crate) message: ::std::option::Option<::std::string::String>,
    pub(crate) compute_time: ::std::option::Option<i64>,
    pub(crate) finished_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) started_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) total_record_count: ::std::option::Option<i64>,
    pub(crate) invalid_record_count: ::std::option::Option<i64>,
}
impl BatchPredictionBuilder {
    /// <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
    pub fn batch_prediction_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.batch_prediction_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
    pub fn set_batch_prediction_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.batch_prediction_id = input;
        self
    }
    /// <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
    pub fn get_batch_prediction_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.batch_prediction_id
    }
    /// <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
    pub fn ml_model_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.ml_model_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
    pub fn set_ml_model_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.ml_model_id = input;
        self
    }
    /// <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
    pub fn get_ml_model_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.ml_model_id
    }
    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
    pub fn batch_prediction_data_source_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.batch_prediction_data_source_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
    pub fn set_batch_prediction_data_source_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.batch_prediction_data_source_id = input;
        self
    }
    /// <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
    pub fn get_batch_prediction_data_source_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.batch_prediction_data_source_id
    }
    /// <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
    pub fn input_data_location_s3(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.input_data_location_s3 = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
    pub fn set_input_data_location_s3(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.input_data_location_s3 = input;
        self
    }
    /// <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
    pub fn get_input_data_location_s3(&self) -> &::std::option::Option<::std::string::String> {
        &self.input_data_location_s3
    }
    /// <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
    pub fn created_by_iam_user(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.created_by_iam_user = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
    pub fn set_created_by_iam_user(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.created_by_iam_user = input;
        self
    }
    /// <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
    pub fn get_created_by_iam_user(&self) -> &::std::option::Option<::std::string::String> {
        &self.created_by_iam_user
    }
    /// <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_at = input;
        self
    }
    /// <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
    pub fn last_updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_updated_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
    pub fn set_last_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_updated_at = input;
        self
    }
    /// <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
    pub fn get_last_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_updated_at
    }
    /// <p>A user-supplied name or description of the <code>BatchPrediction</code>.</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>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.</p></li>
    /// <li>
    /// <p><code>INPROGRESS</code> - The process is underway.</p></li>
    /// <li>
    /// <p><code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p></li>
    /// <li>
    /// <p><code>COMPLETED</code> - The batch prediction process completed successfully.</p></li>
    /// <li>
    /// <p><code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p></li>
    /// </ul>
    pub fn status(mut self, input: crate::types::EntityStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.</p></li>
    /// <li>
    /// <p><code>INPROGRESS</code> - The process is underway.</p></li>
    /// <li>
    /// <p><code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p></li>
    /// <li>
    /// <p><code>COMPLETED</code> - The batch prediction process completed successfully.</p></li>
    /// <li>
    /// <p><code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p></li>
    /// </ul>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::EntityStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.</p></li>
    /// <li>
    /// <p><code>INPROGRESS</code> - The process is underway.</p></li>
    /// <li>
    /// <p><code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p></li>
    /// <li>
    /// <p><code>COMPLETED</code> - The batch prediction process completed successfully.</p></li>
    /// <li>
    /// <p><code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p></li>
    /// </ul>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::EntityStatus> {
        &self.status
    }
    /// <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
    pub fn output_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.output_uri = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
    pub fn set_output_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.output_uri = input;
        self
    }
    /// <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
    pub fn get_output_uri(&self) -> &::std::option::Option<::std::string::String> {
        &self.output_uri
    }
    /// <p>A description of the most recent details about processing the batch prediction request.</p>
    pub fn message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.message = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the most recent details about processing the batch prediction request.</p>
    pub fn set_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.message = input;
        self
    }
    /// <p>A description of the most recent details about processing the batch prediction request.</p>
    pub fn get_message(&self) -> &::std::option::Option<::std::string::String> {
        &self.message
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn compute_time(mut self, input: i64) -> Self {
        self.compute_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn set_compute_time(mut self, input: ::std::option::Option<i64>) -> Self {
        self.compute_time = input;
        self
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn get_compute_time(&self) -> &::std::option::Option<i64> {
        &self.compute_time
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn finished_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.finished_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn set_finished_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.finished_at = input;
        self
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn get_finished_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.finished_at
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn started_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.started_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn set_started_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.started_at = input;
        self
    }
    /// <p>A timestamp represented in epoch time.</p>
    pub fn get_started_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.started_at
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn total_record_count(mut self, input: i64) -> Self {
        self.total_record_count = ::std::option::Option::Some(input);
        self
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn set_total_record_count(mut self, input: ::std::option::Option<i64>) -> Self {
        self.total_record_count = input;
        self
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn get_total_record_count(&self) -> &::std::option::Option<i64> {
        &self.total_record_count
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn invalid_record_count(mut self, input: i64) -> Self {
        self.invalid_record_count = ::std::option::Option::Some(input);
        self
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn set_invalid_record_count(mut self, input: ::std::option::Option<i64>) -> Self {
        self.invalid_record_count = input;
        self
    }
    /// <p>Long integer type that is a 64-bit signed number.</p>
    pub fn get_invalid_record_count(&self) -> &::std::option::Option<i64> {
        &self.invalid_record_count
    }
    /// Consumes the builder and constructs a [`BatchPrediction`](crate::types::BatchPrediction).
    pub fn build(self) -> crate::types::BatchPrediction {
        crate::types::BatchPrediction {
            batch_prediction_id: self.batch_prediction_id,
            ml_model_id: self.ml_model_id,
            batch_prediction_data_source_id: self.batch_prediction_data_source_id,
            input_data_location_s3: self.input_data_location_s3,
            created_by_iam_user: self.created_by_iam_user,
            created_at: self.created_at,
            last_updated_at: self.last_updated_at,
            name: self.name,
            status: self.status,
            output_uri: self.output_uri,
            message: self.message,
            compute_time: self.compute_time,
            finished_at: self.finished_at,
            started_at: self.started_at,
            total_record_count: self.total_record_count,
            invalid_record_count: self.invalid_record_count,
        }
    }
}