aws-sdk-storagegateway 1.115.0

AWS SDK for AWS Storage Gateway
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>JoinDomainOutput</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct JoinDomainOutput {
    /// <p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>
    pub gateway_arn: ::std::option::Option<::std::string::String>,
    /// <p>Indicates the status of the gateway as a member of the Active Directory domain.</p><note>
    /// <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p>
    /// </note>
    /// <ul>
    /// <li>
    /// <p><code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p></li>
    /// <li>
    /// <p><code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p></li>
    /// <li>
    /// <p><code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p></li>
    /// <li>
    /// <p><code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p></li>
    /// <li>
    /// <p><code>INSUFFICIENT_PERMISSIONS</code>: Indicates that the <code>JoinDomain</code> operation failed because the specified user lacks the necessary permissions to join the domain.</p></li>
    /// <li>
    /// <p><code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p></li>
    /// <li>
    /// <p><code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p></li>
    /// <li>
    /// <p><code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p></li>
    /// </ul>
    pub active_directory_status: ::std::option::Option<crate::types::ActiveDirectoryStatus>,
    _request_id: Option<String>,
}
impl JoinDomainOutput {
    /// <p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>
    pub fn gateway_arn(&self) -> ::std::option::Option<&str> {
        self.gateway_arn.as_deref()
    }
    /// <p>Indicates the status of the gateway as a member of the Active Directory domain.</p><note>
    /// <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p>
    /// </note>
    /// <ul>
    /// <li>
    /// <p><code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p></li>
    /// <li>
    /// <p><code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p></li>
    /// <li>
    /// <p><code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p></li>
    /// <li>
    /// <p><code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p></li>
    /// <li>
    /// <p><code>INSUFFICIENT_PERMISSIONS</code>: Indicates that the <code>JoinDomain</code> operation failed because the specified user lacks the necessary permissions to join the domain.</p></li>
    /// <li>
    /// <p><code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p></li>
    /// <li>
    /// <p><code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p></li>
    /// <li>
    /// <p><code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p></li>
    /// </ul>
    pub fn active_directory_status(&self) -> ::std::option::Option<&crate::types::ActiveDirectoryStatus> {
        self.active_directory_status.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for JoinDomainOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl JoinDomainOutput {
    /// Creates a new builder-style object to manufacture [`JoinDomainOutput`](crate::operation::join_domain::JoinDomainOutput).
    pub fn builder() -> crate::operation::join_domain::builders::JoinDomainOutputBuilder {
        crate::operation::join_domain::builders::JoinDomainOutputBuilder::default()
    }
}

/// A builder for [`JoinDomainOutput`](crate::operation::join_domain::JoinDomainOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct JoinDomainOutputBuilder {
    pub(crate) gateway_arn: ::std::option::Option<::std::string::String>,
    pub(crate) active_directory_status: ::std::option::Option<crate::types::ActiveDirectoryStatus>,
    _request_id: Option<String>,
}
impl JoinDomainOutputBuilder {
    /// <p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>
    pub fn gateway_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.gateway_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>
    pub fn set_gateway_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.gateway_arn = input;
        self
    }
    /// <p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>
    pub fn get_gateway_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.gateway_arn
    }
    /// <p>Indicates the status of the gateway as a member of the Active Directory domain.</p><note>
    /// <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p>
    /// </note>
    /// <ul>
    /// <li>
    /// <p><code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p></li>
    /// <li>
    /// <p><code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p></li>
    /// <li>
    /// <p><code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p></li>
    /// <li>
    /// <p><code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p></li>
    /// <li>
    /// <p><code>INSUFFICIENT_PERMISSIONS</code>: Indicates that the <code>JoinDomain</code> operation failed because the specified user lacks the necessary permissions to join the domain.</p></li>
    /// <li>
    /// <p><code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p></li>
    /// <li>
    /// <p><code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p></li>
    /// <li>
    /// <p><code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p></li>
    /// </ul>
    pub fn active_directory_status(mut self, input: crate::types::ActiveDirectoryStatus) -> Self {
        self.active_directory_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates the status of the gateway as a member of the Active Directory domain.</p><note>
    /// <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p>
    /// </note>
    /// <ul>
    /// <li>
    /// <p><code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p></li>
    /// <li>
    /// <p><code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p></li>
    /// <li>
    /// <p><code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p></li>
    /// <li>
    /// <p><code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p></li>
    /// <li>
    /// <p><code>INSUFFICIENT_PERMISSIONS</code>: Indicates that the <code>JoinDomain</code> operation failed because the specified user lacks the necessary permissions to join the domain.</p></li>
    /// <li>
    /// <p><code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p></li>
    /// <li>
    /// <p><code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p></li>
    /// <li>
    /// <p><code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p></li>
    /// </ul>
    pub fn set_active_directory_status(mut self, input: ::std::option::Option<crate::types::ActiveDirectoryStatus>) -> Self {
        self.active_directory_status = input;
        self
    }
    /// <p>Indicates the status of the gateway as a member of the Active Directory domain.</p><note>
    /// <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p>
    /// </note>
    /// <ul>
    /// <li>
    /// <p><code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p></li>
    /// <li>
    /// <p><code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p></li>
    /// <li>
    /// <p><code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p></li>
    /// <li>
    /// <p><code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p></li>
    /// <li>
    /// <p><code>INSUFFICIENT_PERMISSIONS</code>: Indicates that the <code>JoinDomain</code> operation failed because the specified user lacks the necessary permissions to join the domain.</p></li>
    /// <li>
    /// <p><code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p></li>
    /// <li>
    /// <p><code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p></li>
    /// <li>
    /// <p><code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p></li>
    /// </ul>
    pub fn get_active_directory_status(&self) -> &::std::option::Option<crate::types::ActiveDirectoryStatus> {
        &self.active_directory_status
    }
    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 [`JoinDomainOutput`](crate::operation::join_domain::JoinDomainOutput).
    pub fn build(self) -> crate::operation::join_domain::JoinDomainOutput {
        crate::operation::join_domain::JoinDomainOutput {
            gateway_arn: self.gateway_arn,
            active_directory_status: self.active_directory_status,
            _request_id: self._request_id,
        }
    }
}