aws-sdk-networksecuritymanager 1.2.0

AWS SDK for AWS Network Security Manager Customer API
Documentation
// 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 GetScopeOutput {
    /// <p>The service-generated id of the scope.</p>
    pub scope_id: ::std::string::String,
    /// <p>The Amazon Resource Name (ARN) of the scope.</p>
    pub scope_arn: ::std::string::String,
    /// <p>The name of the scope.</p>
    pub scope_name: ::std::string::String,
    /// <p>A description of the scope.</p>
    pub scope_description: ::std::option::Option<::std::string::String>,
    /// <p>The configuration that defines which accounts and resources are in scope.</p>
    pub scope_configuration: ::std::option::Option<crate::types::ScopeConfiguration>,
    /// <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable), <code>ACTIVE</code> (published, in use), or <code>DISABLED</code> (deactivated; changes cannot be published until the resource is re-enabled).</p>
    pub status: crate::types::EntityStatus,
    /// <p>The version of the resource.</p>
    pub version: ::std::string::String,
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub update_token: ::std::option::Option<::std::string::String>,
    /// <p>Specifies whether the resource is a snapshot of a published version.</p>
    pub is_snapshot: ::std::option::Option<bool>,
    /// <p>Specifies whether a published version of the resource exists.</p>
    pub has_published_version: ::std::option::Option<bool>,
    /// <p>The time when the resource was last updated.</p>
    pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl GetScopeOutput {
    /// <p>The service-generated id of the scope.</p>
    pub fn scope_id(&self) -> &str {
        use std::ops::Deref;
        self.scope_id.deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the scope.</p>
    pub fn scope_arn(&self) -> &str {
        use std::ops::Deref;
        self.scope_arn.deref()
    }
    /// <p>The name of the scope.</p>
    pub fn scope_name(&self) -> &str {
        use std::ops::Deref;
        self.scope_name.deref()
    }
    /// <p>A description of the scope.</p>
    pub fn scope_description(&self) -> ::std::option::Option<&str> {
        self.scope_description.as_deref()
    }
    /// <p>The configuration that defines which accounts and resources are in scope.</p>
    pub fn scope_configuration(&self) -> ::std::option::Option<&crate::types::ScopeConfiguration> {
        self.scope_configuration.as_ref()
    }
    /// <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable), <code>ACTIVE</code> (published, in use), or <code>DISABLED</code> (deactivated; changes cannot be published until the resource is re-enabled).</p>
    pub fn status(&self) -> &crate::types::EntityStatus {
        &self.status
    }
    /// <p>The version of the resource.</p>
    pub fn version(&self) -> &str {
        use std::ops::Deref;
        self.version.deref()
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub fn update_token(&self) -> ::std::option::Option<&str> {
        self.update_token.as_deref()
    }
    /// <p>Specifies whether the resource is a snapshot of a published version.</p>
    pub fn is_snapshot(&self) -> ::std::option::Option<bool> {
        self.is_snapshot
    }
    /// <p>Specifies whether a published version of the resource exists.</p>
    pub fn has_published_version(&self) -> ::std::option::Option<bool> {
        self.has_published_version
    }
    /// <p>The time when the resource was last updated.</p>
    pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.updated_at.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for GetScopeOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetScopeOutput {
    /// Creates a new builder-style object to manufacture [`GetScopeOutput`](crate::operation::get_scope::GetScopeOutput).
    pub fn builder() -> crate::operation::get_scope::builders::GetScopeOutputBuilder {
        crate::operation::get_scope::builders::GetScopeOutputBuilder::default()
    }
}

/// A builder for [`GetScopeOutput`](crate::operation::get_scope::GetScopeOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetScopeOutputBuilder {
    pub(crate) scope_id: ::std::option::Option<::std::string::String>,
    pub(crate) scope_arn: ::std::option::Option<::std::string::String>,
    pub(crate) scope_name: ::std::option::Option<::std::string::String>,
    pub(crate) scope_description: ::std::option::Option<::std::string::String>,
    pub(crate) scope_configuration: ::std::option::Option<crate::types::ScopeConfiguration>,
    pub(crate) status: ::std::option::Option<crate::types::EntityStatus>,
    pub(crate) version: ::std::option::Option<::std::string::String>,
    pub(crate) update_token: ::std::option::Option<::std::string::String>,
    pub(crate) is_snapshot: ::std::option::Option<bool>,
    pub(crate) has_published_version: ::std::option::Option<bool>,
    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl GetScopeOutputBuilder {
    /// <p>The service-generated id of the scope.</p>
    /// This field is required.
    pub fn scope_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scope_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The service-generated id of the scope.</p>
    pub fn set_scope_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scope_id = input;
        self
    }
    /// <p>The service-generated id of the scope.</p>
    pub fn get_scope_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.scope_id
    }
    /// <p>The Amazon Resource Name (ARN) of the scope.</p>
    /// This field is required.
    pub fn scope_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scope_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the scope.</p>
    pub fn set_scope_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scope_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the scope.</p>
    pub fn get_scope_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.scope_arn
    }
    /// <p>The name of the scope.</p>
    /// This field is required.
    pub fn scope_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scope_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the scope.</p>
    pub fn set_scope_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scope_name = input;
        self
    }
    /// <p>The name of the scope.</p>
    pub fn get_scope_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.scope_name
    }
    /// <p>A description of the scope.</p>
    pub fn scope_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scope_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the scope.</p>
    pub fn set_scope_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scope_description = input;
        self
    }
    /// <p>A description of the scope.</p>
    pub fn get_scope_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.scope_description
    }
    /// <p>The configuration that defines which accounts and resources are in scope.</p>
    pub fn scope_configuration(mut self, input: crate::types::ScopeConfiguration) -> Self {
        self.scope_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration that defines which accounts and resources are in scope.</p>
    pub fn set_scope_configuration(mut self, input: ::std::option::Option<crate::types::ScopeConfiguration>) -> Self {
        self.scope_configuration = input;
        self
    }
    /// <p>The configuration that defines which accounts and resources are in scope.</p>
    pub fn get_scope_configuration(&self) -> &::std::option::Option<crate::types::ScopeConfiguration> {
        &self.scope_configuration
    }
    /// <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable), <code>ACTIVE</code> (published, in use), or <code>DISABLED</code> (deactivated; changes cannot be published until the resource is re-enabled).</p>
    /// This field is required.
    pub fn status(mut self, input: crate::types::EntityStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable), <code>ACTIVE</code> (published, in use), or <code>DISABLED</code> (deactivated; changes cannot be published until the resource is re-enabled).</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::EntityStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable), <code>ACTIVE</code> (published, in use), or <code>DISABLED</code> (deactivated; changes cannot be published until the resource is re-enabled).</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::EntityStatus> {
        &self.status
    }
    /// <p>The version of the resource.</p>
    /// This field is required.
    pub fn version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.version = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The version of the resource.</p>
    pub fn set_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.version = input;
        self
    }
    /// <p>The version of the resource.</p>
    pub fn get_version(&self) -> &::std::option::Option<::std::string::String> {
        &self.version
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub fn update_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.update_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub fn set_update_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.update_token = input;
        self
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub fn get_update_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.update_token
    }
    /// <p>Specifies whether the resource is a snapshot of a published version.</p>
    pub fn is_snapshot(mut self, input: bool) -> Self {
        self.is_snapshot = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies whether the resource is a snapshot of a published version.</p>
    pub fn set_is_snapshot(mut self, input: ::std::option::Option<bool>) -> Self {
        self.is_snapshot = input;
        self
    }
    /// <p>Specifies whether the resource is a snapshot of a published version.</p>
    pub fn get_is_snapshot(&self) -> &::std::option::Option<bool> {
        &self.is_snapshot
    }
    /// <p>Specifies whether a published version of the resource exists.</p>
    pub fn has_published_version(mut self, input: bool) -> Self {
        self.has_published_version = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies whether a published version of the resource exists.</p>
    pub fn set_has_published_version(mut self, input: ::std::option::Option<bool>) -> Self {
        self.has_published_version = input;
        self
    }
    /// <p>Specifies whether a published version of the resource exists.</p>
    pub fn get_has_published_version(&self) -> &::std::option::Option<bool> {
        &self.has_published_version
    }
    /// <p>The time when the resource was last updated.</p>
    pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.updated_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time when the resource was last updated.</p>
    pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.updated_at = input;
        self
    }
    /// <p>The time when the resource was last updated.</p>
    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.updated_at
    }
    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 [`GetScopeOutput`](crate::operation::get_scope::GetScopeOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`scope_id`](crate::operation::get_scope::builders::GetScopeOutputBuilder::scope_id)
    /// - [`scope_arn`](crate::operation::get_scope::builders::GetScopeOutputBuilder::scope_arn)
    /// - [`scope_name`](crate::operation::get_scope::builders::GetScopeOutputBuilder::scope_name)
    /// - [`status`](crate::operation::get_scope::builders::GetScopeOutputBuilder::status)
    /// - [`version`](crate::operation::get_scope::builders::GetScopeOutputBuilder::version)
    pub fn build(self) -> ::std::result::Result<crate::operation::get_scope::GetScopeOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_scope::GetScopeOutput {
            scope_id: self.scope_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "scope_id",
                    "scope_id was not specified but it is required when building GetScopeOutput",
                )
            })?,
            scope_arn: self.scope_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "scope_arn",
                    "scope_arn was not specified but it is required when building GetScopeOutput",
                )
            })?,
            scope_name: self.scope_name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "scope_name",
                    "scope_name was not specified but it is required when building GetScopeOutput",
                )
            })?,
            scope_description: self.scope_description,
            scope_configuration: self.scope_configuration,
            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 GetScopeOutput",
                )
            })?,
            version: self.version.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "version",
                    "version was not specified but it is required when building GetScopeOutput",
                )
            })?,
            update_token: self.update_token,
            is_snapshot: self.is_snapshot,
            has_published_version: self.has_published_version,
            updated_at: self.updated_at,
            _request_id: self._request_id,
        })
    }
}