aws-sdk-omics 1.108.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, ::std::fmt::Debug)]
pub struct GetBatchOutput {
    /// <p>The identifier portion of the run batch ARN.</p>
    pub id: ::std::option::Option<::std::string::String>,
    /// <p>The unique ARN of the run batch.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>The universally unique identifier (UUID) for the run batch.</p>
    pub uuid: ::std::option::Option<::std::string::String>,
    /// <p>The optional user-friendly name of the batch.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETED</code> (runs deleted).</p>
    pub status: ::std::option::Option<crate::types::BatchStatus>,
    /// <p>AWS tags associated with the run batch.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>The total number of runs in the batch.</p>
    pub total_runs: ::std::option::Option<i32>,
    /// <p>The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.</p>
    pub default_run_setting: ::std::option::Option<crate::types::DefaultRunSetting>,
    /// <p>A summary of run submission outcomes. See <code>SubmissionSummary</code>.</p>
    pub submission_summary: ::std::option::Option<crate::types::SubmissionSummary>,
    /// <p>A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches <code>PROCESSED</code> status. See <code>RunSummary</code>.</p>
    pub run_summary: ::std::option::Option<crate::types::RunSummary>,
    /// <p>The timestamp when the batch was created.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The timestamp when all run submissions completed.</p>
    pub submitted_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The timestamp when all run executions completed.</p>
    pub processed_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The timestamp when the batch transitioned to a <code>FAILED</code> status.</p>
    pub failed_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A description of the batch failure. Present only when status is <code>FAILED</code>.</p>
    pub failure_reason: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetBatchOutput {
    /// <p>The identifier portion of the run batch ARN.</p>
    pub fn id(&self) -> ::std::option::Option<&str> {
        self.id.as_deref()
    }
    /// <p>The unique ARN of the run batch.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>The universally unique identifier (UUID) for the run batch.</p>
    pub fn uuid(&self) -> ::std::option::Option<&str> {
        self.uuid.as_deref()
    }
    /// <p>The optional user-friendly name of the batch.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETED</code> (runs deleted).</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::BatchStatus> {
        self.status.as_ref()
    }
    /// <p>AWS tags associated with the run batch.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
    /// <p>The total number of runs in the batch.</p>
    pub fn total_runs(&self) -> ::std::option::Option<i32> {
        self.total_runs
    }
    /// <p>The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.</p>
    pub fn default_run_setting(&self) -> ::std::option::Option<&crate::types::DefaultRunSetting> {
        self.default_run_setting.as_ref()
    }
    /// <p>A summary of run submission outcomes. See <code>SubmissionSummary</code>.</p>
    pub fn submission_summary(&self) -> ::std::option::Option<&crate::types::SubmissionSummary> {
        self.submission_summary.as_ref()
    }
    /// <p>A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches <code>PROCESSED</code> status. See <code>RunSummary</code>.</p>
    pub fn run_summary(&self) -> ::std::option::Option<&crate::types::RunSummary> {
        self.run_summary.as_ref()
    }
    /// <p>The timestamp when the batch was created.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.as_ref()
    }
    /// <p>The timestamp when all run submissions completed.</p>
    pub fn submitted_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.submitted_time.as_ref()
    }
    /// <p>The timestamp when all run executions completed.</p>
    pub fn processed_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.processed_time.as_ref()
    }
    /// <p>The timestamp when the batch transitioned to a <code>FAILED</code> status.</p>
    pub fn failed_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.failed_time.as_ref()
    }
    /// <p>A description of the batch failure. Present only when status is <code>FAILED</code>.</p>
    pub fn failure_reason(&self) -> ::std::option::Option<&str> {
        self.failure_reason.as_deref()
    }
}
impl ::aws_types::request_id::RequestId for GetBatchOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetBatchOutput {
    /// Creates a new builder-style object to manufacture [`GetBatchOutput`](crate::operation::get_batch::GetBatchOutput).
    pub fn builder() -> crate::operation::get_batch::builders::GetBatchOutputBuilder {
        crate::operation::get_batch::builders::GetBatchOutputBuilder::default()
    }
}

/// A builder for [`GetBatchOutput`](crate::operation::get_batch::GetBatchOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetBatchOutputBuilder {
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) uuid: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::BatchStatus>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) total_runs: ::std::option::Option<i32>,
    pub(crate) default_run_setting: ::std::option::Option<crate::types::DefaultRunSetting>,
    pub(crate) submission_summary: ::std::option::Option<crate::types::SubmissionSummary>,
    pub(crate) run_summary: ::std::option::Option<crate::types::RunSummary>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) submitted_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) processed_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) failed_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetBatchOutputBuilder {
    /// <p>The identifier portion of the run batch ARN.</p>
    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier portion of the run batch ARN.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The identifier portion of the run batch ARN.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The unique ARN of the run batch.</p>
    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 unique ARN of the run batch.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>The unique ARN of the run batch.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>The universally unique identifier (UUID) for the run batch.</p>
    pub fn uuid(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.uuid = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The universally unique identifier (UUID) for the run batch.</p>
    pub fn set_uuid(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.uuid = input;
        self
    }
    /// <p>The universally unique identifier (UUID) for the run batch.</p>
    pub fn get_uuid(&self) -> &::std::option::Option<::std::string::String> {
        &self.uuid
    }
    /// <p>The optional user-friendly name of the batch.</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 optional user-friendly name of the batch.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The optional user-friendly name of the batch.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETED</code> (runs deleted).</p>
    pub fn status(mut self, input: crate::types::BatchStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETED</code> (runs deleted).</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::BatchStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETED</code> (runs deleted).</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::BatchStatus> {
        &self.status
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>AWS tags associated with the run batch.</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>AWS tags associated with the run batch.</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>AWS tags associated with the run batch.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// <p>The total number of runs in the batch.</p>
    pub fn total_runs(mut self, input: i32) -> Self {
        self.total_runs = ::std::option::Option::Some(input);
        self
    }
    /// <p>The total number of runs in the batch.</p>
    pub fn set_total_runs(mut self, input: ::std::option::Option<i32>) -> Self {
        self.total_runs = input;
        self
    }
    /// <p>The total number of runs in the batch.</p>
    pub fn get_total_runs(&self) -> &::std::option::Option<i32> {
        &self.total_runs
    }
    /// <p>The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.</p>
    pub fn default_run_setting(mut self, input: crate::types::DefaultRunSetting) -> Self {
        self.default_run_setting = ::std::option::Option::Some(input);
        self
    }
    /// <p>The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.</p>
    pub fn set_default_run_setting(mut self, input: ::std::option::Option<crate::types::DefaultRunSetting>) -> Self {
        self.default_run_setting = input;
        self
    }
    /// <p>The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.</p>
    pub fn get_default_run_setting(&self) -> &::std::option::Option<crate::types::DefaultRunSetting> {
        &self.default_run_setting
    }
    /// <p>A summary of run submission outcomes. See <code>SubmissionSummary</code>.</p>
    pub fn submission_summary(mut self, input: crate::types::SubmissionSummary) -> Self {
        self.submission_summary = ::std::option::Option::Some(input);
        self
    }
    /// <p>A summary of run submission outcomes. See <code>SubmissionSummary</code>.</p>
    pub fn set_submission_summary(mut self, input: ::std::option::Option<crate::types::SubmissionSummary>) -> Self {
        self.submission_summary = input;
        self
    }
    /// <p>A summary of run submission outcomes. See <code>SubmissionSummary</code>.</p>
    pub fn get_submission_summary(&self) -> &::std::option::Option<crate::types::SubmissionSummary> {
        &self.submission_summary
    }
    /// <p>A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches <code>PROCESSED</code> status. See <code>RunSummary</code>.</p>
    pub fn run_summary(mut self, input: crate::types::RunSummary) -> Self {
        self.run_summary = ::std::option::Option::Some(input);
        self
    }
    /// <p>A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches <code>PROCESSED</code> status. See <code>RunSummary</code>.</p>
    pub fn set_run_summary(mut self, input: ::std::option::Option<crate::types::RunSummary>) -> Self {
        self.run_summary = input;
        self
    }
    /// <p>A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches <code>PROCESSED</code> status. See <code>RunSummary</code>.</p>
    pub fn get_run_summary(&self) -> &::std::option::Option<crate::types::RunSummary> {
        &self.run_summary
    }
    /// <p>The timestamp when the batch was created.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when the batch was created.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>The timestamp when the batch was created.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// <p>The timestamp when all run submissions completed.</p>
    pub fn submitted_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.submitted_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when all run submissions completed.</p>
    pub fn set_submitted_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.submitted_time = input;
        self
    }
    /// <p>The timestamp when all run submissions completed.</p>
    pub fn get_submitted_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.submitted_time
    }
    /// <p>The timestamp when all run executions completed.</p>
    pub fn processed_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.processed_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when all run executions completed.</p>
    pub fn set_processed_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.processed_time = input;
        self
    }
    /// <p>The timestamp when all run executions completed.</p>
    pub fn get_processed_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.processed_time
    }
    /// <p>The timestamp when the batch transitioned to a <code>FAILED</code> status.</p>
    pub fn failed_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.failed_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when the batch transitioned to a <code>FAILED</code> status.</p>
    pub fn set_failed_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.failed_time = input;
        self
    }
    /// <p>The timestamp when the batch transitioned to a <code>FAILED</code> status.</p>
    pub fn get_failed_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.failed_time
    }
    /// <p>A description of the batch failure. Present only when status is <code>FAILED</code>.</p>
    pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.failure_reason = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the batch failure. Present only when status is <code>FAILED</code>.</p>
    pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.failure_reason = input;
        self
    }
    /// <p>A description of the batch failure. Present only when status is <code>FAILED</code>.</p>
    pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
        &self.failure_reason
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`GetBatchOutput`](crate::operation::get_batch::GetBatchOutput).
    pub fn build(self) -> crate::operation::get_batch::GetBatchOutput {
        crate::operation::get_batch::GetBatchOutput {
            id: self.id,
            arn: self.arn,
            uuid: self.uuid,
            name: self.name,
            status: self.status,
            tags: self.tags,
            total_runs: self.total_runs,
            default_run_setting: self.default_run_setting,
            submission_summary: self.submission_summary,
            run_summary: self.run_summary,
            creation_time: self.creation_time,
            submitted_time: self.submitted_time,
            processed_time: self.processed_time,
            failed_time: self.failed_time,
            failure_reason: self.failure_reason,
            _request_id: self._request_id,
        }
    }
}