aws-sdk-location 1.103.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 GetJobOutput {
    /// <p>Action performed by the job.</p>
    pub action: crate::types::JobAction,
    /// <p>Additional options for configuring job action parameters.</p>
    pub action_options: ::std::option::Option<crate::types::JobActionOptions>,
    /// <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub created_at: ::aws_smithy_types::DateTime,
    /// <p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
    pub ended_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Error information if the job failed.</p>
    pub error: ::std::option::Option<crate::types::JobError>,
    /// <p>IAM role used for permissions when running the job.</p>
    pub execution_role_arn: ::std::string::String,
    /// <p>Input configuration.</p>
    pub input_options: ::std::option::Option<crate::types::JobInputOptions>,
    /// <p>Amazon Resource Name (ARN) of the specified job.</p>
    pub job_arn: ::std::string::String,
    /// <p>Unique job identifier.</p>
    pub job_id: ::std::string::String,
    /// <p>Job name (if provided during creation).</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>Output configuration.</p>
    pub output_options: ::std::option::Option<crate::types::JobOutputOptions>,
    /// <p>Current job status.</p>
    pub status: crate::types::JobStatus,
    /// <p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub updated_at: ::aws_smithy_types::DateTime,
    /// <p>Tags and corresponding values associated with the specified job.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    _request_id: Option<String>,
}
impl GetJobOutput {
    /// <p>Action performed by the job.</p>
    pub fn action(&self) -> &crate::types::JobAction {
        &self.action
    }
    /// <p>Additional options for configuring job action parameters.</p>
    pub fn action_options(&self) -> ::std::option::Option<&crate::types::JobActionOptions> {
        self.action_options.as_ref()
    }
    /// <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub fn created_at(&self) -> &::aws_smithy_types::DateTime {
        &self.created_at
    }
    /// <p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
    pub fn ended_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.ended_at.as_ref()
    }
    /// <p>Error information if the job failed.</p>
    pub fn error(&self) -> ::std::option::Option<&crate::types::JobError> {
        self.error.as_ref()
    }
    /// <p>IAM role used for permissions when running the job.</p>
    pub fn execution_role_arn(&self) -> &str {
        use std::ops::Deref;
        self.execution_role_arn.deref()
    }
    /// <p>Input configuration.</p>
    pub fn input_options(&self) -> ::std::option::Option<&crate::types::JobInputOptions> {
        self.input_options.as_ref()
    }
    /// <p>Amazon Resource Name (ARN) of the specified job.</p>
    pub fn job_arn(&self) -> &str {
        use std::ops::Deref;
        self.job_arn.deref()
    }
    /// <p>Unique job identifier.</p>
    pub fn job_id(&self) -> &str {
        use std::ops::Deref;
        self.job_id.deref()
    }
    /// <p>Job name (if provided during creation).</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>Output configuration.</p>
    pub fn output_options(&self) -> ::std::option::Option<&crate::types::JobOutputOptions> {
        self.output_options.as_ref()
    }
    /// <p>Current job status.</p>
    pub fn status(&self) -> &crate::types::JobStatus {
        &self.status
    }
    /// <p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub fn updated_at(&self) -> &::aws_smithy_types::DateTime {
        &self.updated_at
    }
    /// <p>Tags and corresponding values associated with the specified job.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl ::std::fmt::Debug for GetJobOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetJobOutput");
        formatter.field("action", &self.action);
        formatter.field("action_options", &self.action_options);
        formatter.field("created_at", &"*** Sensitive Data Redacted ***");
        formatter.field("ended_at", &"*** Sensitive Data Redacted ***");
        formatter.field("error", &self.error);
        formatter.field("execution_role_arn", &self.execution_role_arn);
        formatter.field("input_options", &self.input_options);
        formatter.field("job_arn", &self.job_arn);
        formatter.field("job_id", &self.job_id);
        formatter.field("name", &self.name);
        formatter.field("output_options", &self.output_options);
        formatter.field("status", &self.status);
        formatter.field("updated_at", &"*** Sensitive Data Redacted ***");
        formatter.field("tags", &self.tags);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
impl ::aws_types::request_id::RequestId for GetJobOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetJobOutput {
    /// Creates a new builder-style object to manufacture [`GetJobOutput`](crate::operation::get_job::GetJobOutput).
    pub fn builder() -> crate::operation::get_job::builders::GetJobOutputBuilder {
        crate::operation::get_job::builders::GetJobOutputBuilder::default()
    }
}

/// A builder for [`GetJobOutput`](crate::operation::get_job::GetJobOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct GetJobOutputBuilder {
    pub(crate) action: ::std::option::Option<crate::types::JobAction>,
    pub(crate) action_options: ::std::option::Option<crate::types::JobActionOptions>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) ended_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) error: ::std::option::Option<crate::types::JobError>,
    pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) input_options: ::std::option::Option<crate::types::JobInputOptions>,
    pub(crate) job_arn: ::std::option::Option<::std::string::String>,
    pub(crate) job_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) output_options: ::std::option::Option<crate::types::JobOutputOptions>,
    pub(crate) status: ::std::option::Option<crate::types::JobStatus>,
    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    _request_id: Option<String>,
}
impl GetJobOutputBuilder {
    /// <p>Action performed by the job.</p>
    /// This field is required.
    pub fn action(mut self, input: crate::types::JobAction) -> Self {
        self.action = ::std::option::Option::Some(input);
        self
    }
    /// <p>Action performed by the job.</p>
    pub fn set_action(mut self, input: ::std::option::Option<crate::types::JobAction>) -> Self {
        self.action = input;
        self
    }
    /// <p>Action performed by the job.</p>
    pub fn get_action(&self) -> &::std::option::Option<crate::types::JobAction> {
        &self.action
    }
    /// <p>Additional options for configuring job action parameters.</p>
    pub fn action_options(mut self, input: crate::types::JobActionOptions) -> Self {
        self.action_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Additional options for configuring job action parameters.</p>
    pub fn set_action_options(mut self, input: ::std::option::Option<crate::types::JobActionOptions>) -> Self {
        self.action_options = input;
        self
    }
    /// <p>Additional options for configuring job action parameters.</p>
    pub fn get_action_options(&self) -> &::std::option::Option<crate::types::JobActionOptions> {
        &self.action_options
    }
    /// <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    /// This field is required.
    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_at = input;
        self
    }
    /// <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
    pub fn ended_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.ended_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
    pub fn set_ended_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.ended_at = input;
        self
    }
    /// <p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
    pub fn get_ended_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.ended_at
    }
    /// <p>Error information if the job failed.</p>
    pub fn error(mut self, input: crate::types::JobError) -> Self {
        self.error = ::std::option::Option::Some(input);
        self
    }
    /// <p>Error information if the job failed.</p>
    pub fn set_error(mut self, input: ::std::option::Option<crate::types::JobError>) -> Self {
        self.error = input;
        self
    }
    /// <p>Error information if the job failed.</p>
    pub fn get_error(&self) -> &::std::option::Option<crate::types::JobError> {
        &self.error
    }
    /// <p>IAM role used for permissions when running the job.</p>
    /// This field is required.
    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.execution_role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>IAM role used for permissions when running the job.</p>
    pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.execution_role_arn = input;
        self
    }
    /// <p>IAM role used for permissions when running the job.</p>
    pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.execution_role_arn
    }
    /// <p>Input configuration.</p>
    /// This field is required.
    pub fn input_options(mut self, input: crate::types::JobInputOptions) -> Self {
        self.input_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Input configuration.</p>
    pub fn set_input_options(mut self, input: ::std::option::Option<crate::types::JobInputOptions>) -> Self {
        self.input_options = input;
        self
    }
    /// <p>Input configuration.</p>
    pub fn get_input_options(&self) -> &::std::option::Option<crate::types::JobInputOptions> {
        &self.input_options
    }
    /// <p>Amazon Resource Name (ARN) of the specified job.</p>
    /// This field is required.
    pub fn job_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.job_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Amazon Resource Name (ARN) of the specified job.</p>
    pub fn set_job_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.job_arn = input;
        self
    }
    /// <p>Amazon Resource Name (ARN) of the specified job.</p>
    pub fn get_job_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.job_arn
    }
    /// <p>Unique job identifier.</p>
    /// This field is required.
    pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.job_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Unique job identifier.</p>
    pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.job_id = input;
        self
    }
    /// <p>Unique job identifier.</p>
    pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.job_id
    }
    /// <p>Job name (if provided during creation).</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>Job name (if provided during creation).</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>Job name (if provided during creation).</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>Output configuration.</p>
    /// This field is required.
    pub fn output_options(mut self, input: crate::types::JobOutputOptions) -> Self {
        self.output_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Output configuration.</p>
    pub fn set_output_options(mut self, input: ::std::option::Option<crate::types::JobOutputOptions>) -> Self {
        self.output_options = input;
        self
    }
    /// <p>Output configuration.</p>
    pub fn get_output_options(&self) -> &::std::option::Option<crate::types::JobOutputOptions> {
        &self.output_options
    }
    /// <p>Current job status.</p>
    /// This field is required.
    pub fn status(mut self, input: crate::types::JobStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Current job status.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::JobStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>Current job status.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::JobStatus> {
        &self.status
    }
    /// <p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    /// This field is required.
    pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.updated_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.updated_at = input;
        self
    }
    /// <p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.updated_at
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Tags and corresponding values associated with the specified job.</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>Tags and corresponding values associated with the specified job.</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>Tags and corresponding values associated with the specified job.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    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 [`GetJobOutput`](crate::operation::get_job::GetJobOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`action`](crate::operation::get_job::builders::GetJobOutputBuilder::action)
    /// - [`created_at`](crate::operation::get_job::builders::GetJobOutputBuilder::created_at)
    /// - [`execution_role_arn`](crate::operation::get_job::builders::GetJobOutputBuilder::execution_role_arn)
    /// - [`job_arn`](crate::operation::get_job::builders::GetJobOutputBuilder::job_arn)
    /// - [`job_id`](crate::operation::get_job::builders::GetJobOutputBuilder::job_id)
    /// - [`status`](crate::operation::get_job::builders::GetJobOutputBuilder::status)
    /// - [`updated_at`](crate::operation::get_job::builders::GetJobOutputBuilder::updated_at)
    pub fn build(self) -> ::std::result::Result<crate::operation::get_job::GetJobOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_job::GetJobOutput {
            action: self.action.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "action",
                    "action was not specified but it is required when building GetJobOutput",
                )
            })?,
            action_options: self.action_options,
            created_at: self.created_at.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "created_at",
                    "created_at was not specified but it is required when building GetJobOutput",
                )
            })?,
            ended_at: self.ended_at,
            error: self.error,
            execution_role_arn: self.execution_role_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "execution_role_arn",
                    "execution_role_arn was not specified but it is required when building GetJobOutput",
                )
            })?,
            input_options: self.input_options,
            job_arn: self.job_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "job_arn",
                    "job_arn was not specified but it is required when building GetJobOutput",
                )
            })?,
            job_id: self.job_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "job_id",
                    "job_id was not specified but it is required when building GetJobOutput",
                )
            })?,
            name: self.name,
            output_options: self.output_options,
            status: self.status.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "status",
                    "status was not specified but it is required when building GetJobOutput",
                )
            })?,
            updated_at: self.updated_at.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "updated_at",
                    "updated_at was not specified but it is required when building GetJobOutput",
                )
            })?,
            tags: self.tags,
            _request_id: self._request_id,
        })
    }
}
impl ::std::fmt::Debug for GetJobOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetJobOutputBuilder");
        formatter.field("action", &self.action);
        formatter.field("action_options", &self.action_options);
        formatter.field("created_at", &"*** Sensitive Data Redacted ***");
        formatter.field("ended_at", &"*** Sensitive Data Redacted ***");
        formatter.field("error", &self.error);
        formatter.field("execution_role_arn", &self.execution_role_arn);
        formatter.field("input_options", &self.input_options);
        formatter.field("job_arn", &self.job_arn);
        formatter.field("job_id", &self.job_id);
        formatter.field("name", &self.name);
        formatter.field("output_options", &self.output_options);
        formatter.field("status", &self.status);
        formatter.field("updated_at", &"*** Sensitive Data Redacted ***");
        formatter.field("tags", &self.tags);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}