aws-sdk-datasync 1.130.0

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

/// <p>DescribeAgentResponse</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeAgentOutput {
    /// <p>The ARN of the agent.</p>
    pub agent_arn: ::std::option::Option<::std::string::String>,
    /// <p>The name of the agent.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The status of the agent.</p>
    /// <ul>
    /// <li>
    /// <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to use.</p></li>
    /// <li>
    /// <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a></p></li>
    /// </ul>
    pub status: ::std::option::Option<crate::types::AgentStatus>,
    /// <p>The last time that the agent was communicating with the DataSync service.</p>
    pub last_connection_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The time that the agent was <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activated</a>.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The type of <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html">service endpoint</a> that your agent is connected to.</p>
    pub endpoint_type: ::std::option::Option<crate::types::EndpointType>,
    /// <p>The network configuration that the agent uses when connecting to a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">VPC service endpoint</a>.</p>
    pub private_link_config: ::std::option::Option<crate::types::PrivateLinkConfig>,
    /// <p>The platform-related details about the agent, such as the version number.</p>
    pub platform: ::std::option::Option<crate::types::Platform>,
    _request_id: Option<String>,
}
impl DescribeAgentOutput {
    /// <p>The ARN of the agent.</p>
    pub fn agent_arn(&self) -> ::std::option::Option<&str> {
        self.agent_arn.as_deref()
    }
    /// <p>The name of the agent.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The status of the agent.</p>
    /// <ul>
    /// <li>
    /// <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to use.</p></li>
    /// <li>
    /// <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a></p></li>
    /// </ul>
    pub fn status(&self) -> ::std::option::Option<&crate::types::AgentStatus> {
        self.status.as_ref()
    }
    /// <p>The last time that the agent was communicating with the DataSync service.</p>
    pub fn last_connection_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_connection_time.as_ref()
    }
    /// <p>The time that the agent was <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activated</a>.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.as_ref()
    }
    /// <p>The type of <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html">service endpoint</a> that your agent is connected to.</p>
    pub fn endpoint_type(&self) -> ::std::option::Option<&crate::types::EndpointType> {
        self.endpoint_type.as_ref()
    }
    /// <p>The network configuration that the agent uses when connecting to a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">VPC service endpoint</a>.</p>
    pub fn private_link_config(&self) -> ::std::option::Option<&crate::types::PrivateLinkConfig> {
        self.private_link_config.as_ref()
    }
    /// <p>The platform-related details about the agent, such as the version number.</p>
    pub fn platform(&self) -> ::std::option::Option<&crate::types::Platform> {
        self.platform.as_ref()
    }
}
static DESCRIBEAGENTOUTPUT_MEMBER_AGENT_ARN: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$AgentArn",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "AgentArn",
    0,
);
static DESCRIBEAGENTOUTPUT_MEMBER_NAME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$Name",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "Name",
    1,
);
static DESCRIBEAGENTOUTPUT_MEMBER_STATUS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$Status",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "Status",
    2,
);
static DESCRIBEAGENTOUTPUT_MEMBER_LAST_CONNECTION_TIME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$LastConnectionTime",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::Timestamp,
    "LastConnectionTime",
    3,
);
static DESCRIBEAGENTOUTPUT_MEMBER_CREATION_TIME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$CreationTime",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::Timestamp,
    "CreationTime",
    4,
);
static DESCRIBEAGENTOUTPUT_MEMBER_ENDPOINT_TYPE: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$EndpointType",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "EndpointType",
    5,
);
static DESCRIBEAGENTOUTPUT_MEMBER_PRIVATE_LINK_CONFIG: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$PrivateLinkConfig",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    "PrivateLinkConfig",
    6,
);
static DESCRIBEAGENTOUTPUT_MEMBER_PLATFORM: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput$Platform",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    "Platform",
    7,
);
static DESCRIBEAGENTOUTPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#DescribeAgentOutput",
        "com.amazonaws.datasync.synthetic",
        "DescribeAgentOutput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    &[
        &DESCRIBEAGENTOUTPUT_MEMBER_AGENT_ARN,
        &DESCRIBEAGENTOUTPUT_MEMBER_NAME,
        &DESCRIBEAGENTOUTPUT_MEMBER_STATUS,
        &DESCRIBEAGENTOUTPUT_MEMBER_LAST_CONNECTION_TIME,
        &DESCRIBEAGENTOUTPUT_MEMBER_CREATION_TIME,
        &DESCRIBEAGENTOUTPUT_MEMBER_ENDPOINT_TYPE,
        &DESCRIBEAGENTOUTPUT_MEMBER_PRIVATE_LINK_CONFIG,
        &DESCRIBEAGENTOUTPUT_MEMBER_PLATFORM,
    ],
)
.with_original_name("DescribeAgentResponse");
impl DescribeAgentOutput {
    /// The schema for this shape.
    pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &DESCRIBEAGENTOUTPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for DescribeAgentOutput {
    fn schema(&self) -> &::aws_smithy_schema::Schema<'_> {
        Self::SCHEMA
    }

    #[allow(unused_variables, clippy::diverging_sub_expression)]
    fn serialize_members(
        &self,
        ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        if let Some(ref val) = self.agent_arn {
            ser.write_string(&DESCRIBEAGENTOUTPUT_MEMBER_AGENT_ARN, val)?;
        }
        if let Some(ref val) = self.name {
            ser.write_string(&DESCRIBEAGENTOUTPUT_MEMBER_NAME, val)?;
        }
        if let Some(ref val) = self.status {
            ser.write_string(&DESCRIBEAGENTOUTPUT_MEMBER_STATUS, val.as_str())?;
        }
        if let Some(ref val) = self.last_connection_time {
            ser.write_timestamp(&DESCRIBEAGENTOUTPUT_MEMBER_LAST_CONNECTION_TIME, val)?;
        }
        if let Some(ref val) = self.creation_time {
            ser.write_timestamp(&DESCRIBEAGENTOUTPUT_MEMBER_CREATION_TIME, val)?;
        }
        if let Some(ref val) = self.endpoint_type {
            ser.write_string(&DESCRIBEAGENTOUTPUT_MEMBER_ENDPOINT_TYPE, val.as_str())?;
        }
        if let Some(ref val) = self.private_link_config {
            ser.write_struct(&DESCRIBEAGENTOUTPUT_MEMBER_PRIVATE_LINK_CONFIG, val)?;
        }
        if let Some(ref val) = self.platform {
            ser.write_struct(&DESCRIBEAGENTOUTPUT_MEMBER_PLATFORM, val)?;
        }
        Ok(())
    }
}
impl crate::operation::describe_agent::builders::DescribeAgentOutputBuilder {
    #[allow(
        unused_variables,
        unreachable_code,
        clippy::single_match,
        clippy::match_single_binding,
        clippy::diverging_sub_expression
    )]
    pub(crate) fn deserialize_members(
        &mut self,
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        deserializer.read_struct(&DESCRIBEAGENTOUTPUT_SCHEMA, &mut |member, deser| {
            match member.member_index() {
                Some(0) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.agent_arn = Some(deser.read_string(member)?);
                    }
                }
                Some(1) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.name = Some(deser.read_string(member)?);
                    }
                }
                Some(2) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.status = Some(crate::types::AgentStatus::from(deser.read_string(member)?.as_str()));
                    }
                }
                Some(3) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.last_connection_time = Some(deser.read_timestamp(member)?);
                    }
                }
                Some(4) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.creation_time = Some(deser.read_timestamp(member)?);
                    }
                }
                Some(5) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.endpoint_type = Some(crate::types::EndpointType::from(deser.read_string(member)?.as_str()));
                    }
                }
                Some(6) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.private_link_config = Some(crate::types::PrivateLinkConfig::deserialize(deser)?);
                    }
                }
                Some(7) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.platform = Some(crate::types::Platform::deserialize(deser)?);
                    }
                }
                _ => {}
            }
            Ok(())
        })
    }
}

impl DescribeAgentOutput {
    /// Deserializes this structure from a [`ShapeDeserializer`].
    pub fn deserialize(
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<Self, ::aws_smithy_schema::serde::SerdeError> {
        let mut builder = Self::builder();
        builder.deserialize_members(deserializer)?;
        Ok(builder.build())
    }
}
impl ::aws_types::request_id::RequestId for DescribeAgentOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DescribeAgentOutput {
    /// Creates a new builder-style object to manufacture [`DescribeAgentOutput`](crate::operation::describe_agent::DescribeAgentOutput).
    pub fn builder() -> crate::operation::describe_agent::builders::DescribeAgentOutputBuilder {
        crate::operation::describe_agent::builders::DescribeAgentOutputBuilder::default()
    }
}

/// A builder for [`DescribeAgentOutput`](crate::operation::describe_agent::DescribeAgentOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeAgentOutputBuilder {
    pub(crate) agent_arn: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::AgentStatus>,
    pub(crate) last_connection_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) endpoint_type: ::std::option::Option<crate::types::EndpointType>,
    pub(crate) private_link_config: ::std::option::Option<crate::types::PrivateLinkConfig>,
    pub(crate) platform: ::std::option::Option<crate::types::Platform>,
    _request_id: Option<String>,
}
impl DescribeAgentOutputBuilder {
    /// <p>The ARN of the agent.</p>
    pub fn agent_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.agent_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the agent.</p>
    pub fn set_agent_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.agent_arn = input;
        self
    }
    /// <p>The ARN of the agent.</p>
    pub fn get_agent_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.agent_arn
    }
    /// <p>The name of the agent.</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 agent.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the agent.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The status of the agent.</p>
    /// <ul>
    /// <li>
    /// <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to use.</p></li>
    /// <li>
    /// <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a></p></li>
    /// </ul>
    pub fn status(mut self, input: crate::types::AgentStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the agent.</p>
    /// <ul>
    /// <li>
    /// <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to use.</p></li>
    /// <li>
    /// <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a></p></li>
    /// </ul>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::AgentStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the agent.</p>
    /// <ul>
    /// <li>
    /// <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to use.</p></li>
    /// <li>
    /// <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a></p></li>
    /// </ul>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::AgentStatus> {
        &self.status
    }
    /// <p>The last time that the agent was communicating with the DataSync service.</p>
    pub fn last_connection_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_connection_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The last time that the agent was communicating with the DataSync service.</p>
    pub fn set_last_connection_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_connection_time = input;
        self
    }
    /// <p>The last time that the agent was communicating with the DataSync service.</p>
    pub fn get_last_connection_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_connection_time
    }
    /// <p>The time that the agent was <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activated</a>.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time that the agent was <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activated</a>.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>The time that the agent was <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activated</a>.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// <p>The type of <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html">service endpoint</a> that your agent is connected to.</p>
    pub fn endpoint_type(mut self, input: crate::types::EndpointType) -> Self {
        self.endpoint_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html">service endpoint</a> that your agent is connected to.</p>
    pub fn set_endpoint_type(mut self, input: ::std::option::Option<crate::types::EndpointType>) -> Self {
        self.endpoint_type = input;
        self
    }
    /// <p>The type of <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html">service endpoint</a> that your agent is connected to.</p>
    pub fn get_endpoint_type(&self) -> &::std::option::Option<crate::types::EndpointType> {
        &self.endpoint_type
    }
    /// <p>The network configuration that the agent uses when connecting to a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">VPC service endpoint</a>.</p>
    pub fn private_link_config(mut self, input: crate::types::PrivateLinkConfig) -> Self {
        self.private_link_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The network configuration that the agent uses when connecting to a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">VPC service endpoint</a>.</p>
    pub fn set_private_link_config(mut self, input: ::std::option::Option<crate::types::PrivateLinkConfig>) -> Self {
        self.private_link_config = input;
        self
    }
    /// <p>The network configuration that the agent uses when connecting to a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">VPC service endpoint</a>.</p>
    pub fn get_private_link_config(&self) -> &::std::option::Option<crate::types::PrivateLinkConfig> {
        &self.private_link_config
    }
    /// <p>The platform-related details about the agent, such as the version number.</p>
    pub fn platform(mut self, input: crate::types::Platform) -> Self {
        self.platform = ::std::option::Option::Some(input);
        self
    }
    /// <p>The platform-related details about the agent, such as the version number.</p>
    pub fn set_platform(mut self, input: ::std::option::Option<crate::types::Platform>) -> Self {
        self.platform = input;
        self
    }
    /// <p>The platform-related details about the agent, such as the version number.</p>
    pub fn get_platform(&self) -> &::std::option::Option<crate::types::Platform> {
        &self.platform
    }
    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 [`DescribeAgentOutput`](crate::operation::describe_agent::DescribeAgentOutput).
    pub fn build(self) -> crate::operation::describe_agent::DescribeAgentOutput {
        crate::operation::describe_agent::DescribeAgentOutput {
            agent_arn: self.agent_arn,
            name: self.name,
            status: self.status,
            last_connection_time: self.last_connection_time,
            creation_time: self.creation_time,
            endpoint_type: self.endpoint_type,
            private_link_config: self.private_link_config,
            platform: self.platform,
            _request_id: self._request_id,
        }
    }
}