aws-sdk-mgn 1.102.0

AWS SDK for Application Migration Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Job.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct Job {
    /// <p>Job ID.</p>
    pub job_id: ::std::string::String,
    /// <p>the ARN of the specific Job.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>Job type.</p>
    pub r#type: ::std::option::Option<crate::types::JobType>,
    /// <p>Job initiated by field.</p>
    pub initiated_by: ::std::option::Option<crate::types::InitiatedBy>,
    /// <p>Job creation time.</p>
    pub creation_date_time: ::std::option::Option<::std::string::String>,
    /// <p>Job end time.</p>
    pub end_date_time: ::std::option::Option<::std::string::String>,
    /// <p>Job status.</p>
    pub status: ::std::option::Option<crate::types::JobStatus>,
    /// <p>Servers participating in a specific Job.</p>
    pub participating_servers: ::std::option::Option<::std::vec::Vec<crate::types::ParticipatingServer>>,
    /// <p>Tags associated with specific Job.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl Job {
    /// <p>Job ID.</p>
    pub fn job_id(&self) -> &str {
        use std::ops::Deref;
        self.job_id.deref()
    }
    /// <p>the ARN of the specific Job.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>Job type.</p>
    pub fn r#type(&self) -> ::std::option::Option<&crate::types::JobType> {
        self.r#type.as_ref()
    }
    /// <p>Job initiated by field.</p>
    pub fn initiated_by(&self) -> ::std::option::Option<&crate::types::InitiatedBy> {
        self.initiated_by.as_ref()
    }
    /// <p>Job creation time.</p>
    pub fn creation_date_time(&self) -> ::std::option::Option<&str> {
        self.creation_date_time.as_deref()
    }
    /// <p>Job end time.</p>
    pub fn end_date_time(&self) -> ::std::option::Option<&str> {
        self.end_date_time.as_deref()
    }
    /// <p>Job status.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::JobStatus> {
        self.status.as_ref()
    }
    /// <p>Servers participating in a specific Job.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.participating_servers.is_none()`.
    pub fn participating_servers(&self) -> &[crate::types::ParticipatingServer] {
        self.participating_servers.as_deref().unwrap_or_default()
    }
    /// <p>Tags associated with specific 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 Job {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("Job");
        formatter.field("job_id", &self.job_id);
        formatter.field("arn", &self.arn);
        formatter.field("r#type", &self.r#type);
        formatter.field("initiated_by", &self.initiated_by);
        formatter.field("creation_date_time", &self.creation_date_time);
        formatter.field("end_date_time", &self.end_date_time);
        formatter.field("status", &self.status);
        formatter.field("participating_servers", &self.participating_servers);
        formatter.field("tags", &"*** Sensitive Data Redacted ***");
        formatter.finish()
    }
}
impl Job {
    /// Creates a new builder-style object to manufacture [`Job`](crate::types::Job).
    pub fn builder() -> crate::types::builders::JobBuilder {
        crate::types::builders::JobBuilder::default()
    }
}

/// A builder for [`Job`](crate::types::Job).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct JobBuilder {
    pub(crate) job_id: ::std::option::Option<::std::string::String>,
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) r#type: ::std::option::Option<crate::types::JobType>,
    pub(crate) initiated_by: ::std::option::Option<crate::types::InitiatedBy>,
    pub(crate) creation_date_time: ::std::option::Option<::std::string::String>,
    pub(crate) end_date_time: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::JobStatus>,
    pub(crate) participating_servers: ::std::option::Option<::std::vec::Vec<crate::types::ParticipatingServer>>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl JobBuilder {
    /// <p>Job ID.</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>Job ID.</p>
    pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.job_id = input;
        self
    }
    /// <p>Job ID.</p>
    pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.job_id
    }
    /// <p>the ARN of the specific Job.</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 ARN of the specific Job.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>the ARN of the specific Job.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>Job type.</p>
    pub fn r#type(mut self, input: crate::types::JobType) -> Self {
        self.r#type = ::std::option::Option::Some(input);
        self
    }
    /// <p>Job type.</p>
    pub fn set_type(mut self, input: ::std::option::Option<crate::types::JobType>) -> Self {
        self.r#type = input;
        self
    }
    /// <p>Job type.</p>
    pub fn get_type(&self) -> &::std::option::Option<crate::types::JobType> {
        &self.r#type
    }
    /// <p>Job initiated by field.</p>
    pub fn initiated_by(mut self, input: crate::types::InitiatedBy) -> Self {
        self.initiated_by = ::std::option::Option::Some(input);
        self
    }
    /// <p>Job initiated by field.</p>
    pub fn set_initiated_by(mut self, input: ::std::option::Option<crate::types::InitiatedBy>) -> Self {
        self.initiated_by = input;
        self
    }
    /// <p>Job initiated by field.</p>
    pub fn get_initiated_by(&self) -> &::std::option::Option<crate::types::InitiatedBy> {
        &self.initiated_by
    }
    /// <p>Job creation time.</p>
    pub fn creation_date_time(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.creation_date_time = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Job creation time.</p>
    pub fn set_creation_date_time(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.creation_date_time = input;
        self
    }
    /// <p>Job creation time.</p>
    pub fn get_creation_date_time(&self) -> &::std::option::Option<::std::string::String> {
        &self.creation_date_time
    }
    /// <p>Job end time.</p>
    pub fn end_date_time(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.end_date_time = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Job end time.</p>
    pub fn set_end_date_time(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.end_date_time = input;
        self
    }
    /// <p>Job end time.</p>
    pub fn get_end_date_time(&self) -> &::std::option::Option<::std::string::String> {
        &self.end_date_time
    }
    /// <p>Job status.</p>
    pub fn status(mut self, input: crate::types::JobStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Job status.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::JobStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>Job status.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::JobStatus> {
        &self.status
    }
    /// Appends an item to `participating_servers`.
    ///
    /// To override the contents of this collection use [`set_participating_servers`](Self::set_participating_servers).
    ///
    /// <p>Servers participating in a specific Job.</p>
    pub fn participating_servers(mut self, input: crate::types::ParticipatingServer) -> Self {
        let mut v = self.participating_servers.unwrap_or_default();
        v.push(input);
        self.participating_servers = ::std::option::Option::Some(v);
        self
    }
    /// <p>Servers participating in a specific Job.</p>
    pub fn set_participating_servers(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ParticipatingServer>>) -> Self {
        self.participating_servers = input;
        self
    }
    /// <p>Servers participating in a specific Job.</p>
    pub fn get_participating_servers(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ParticipatingServer>> {
        &self.participating_servers
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Tags associated with specific 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 associated with specific 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 associated with specific Job.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`Job`](crate::types::Job).
    /// This method will fail if any of the following fields are not set:
    /// - [`job_id`](crate::types::builders::JobBuilder::job_id)
    pub fn build(self) -> ::std::result::Result<crate::types::Job, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::Job {
            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 Job",
                )
            })?,
            arn: self.arn,
            r#type: self.r#type,
            initiated_by: self.initiated_by,
            creation_date_time: self.creation_date_time,
            end_date_time: self.end_date_time,
            status: self.status,
            participating_servers: self.participating_servers,
            tags: self.tags,
        })
    }
}
impl ::std::fmt::Debug for JobBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("JobBuilder");
        formatter.field("job_id", &self.job_id);
        formatter.field("arn", &self.arn);
        formatter.field("r#type", &self.r#type);
        formatter.field("initiated_by", &self.initiated_by);
        formatter.field("creation_date_time", &self.creation_date_time);
        formatter.field("end_date_time", &self.end_date_time);
        formatter.field("status", &self.status);
        formatter.field("participating_servers", &self.participating_servers);
        formatter.field("tags", &"*** Sensitive Data Redacted ***");
        formatter.finish()
    }
}