aws-sdk-servicediscovery 1.98.0

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

/// <p>A complex type that contains information about a specified namespace.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Namespace {
    /// <p>The ID of a namespace.</p>
    pub id: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
    pub resource_owner: ::std::option::Option<::std::string::String>,
    /// <p>The name of the namespace, such as <code>example.com</code>.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The type of the namespace. The methods for discovering instances depends on the value that you specify:</p>
    /// <dl>
    /// <dt>
    /// HTTP
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PUBLIC
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PRIVATE
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// </dl>
    pub r#type: ::std::option::Option<crate::types::NamespaceType>,
    /// <p>The description that you specify for the namespace when you create it.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The number of services that are associated with the namespace.</p>
    pub service_count: ::std::option::Option<i32>,
    /// <p>A complex type that contains information that's specific to the type of the namespace.</p>
    pub properties: ::std::option::Option<crate::types::NamespaceProperties>,
    /// <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    pub create_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.</p>
    pub creator_request_id: ::std::option::Option<::std::string::String>,
}
impl Namespace {
    /// <p>The ID of a namespace.</p>
    pub fn id(&self) -> ::std::option::Option<&str> {
        self.id.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
    pub fn resource_owner(&self) -> ::std::option::Option<&str> {
        self.resource_owner.as_deref()
    }
    /// <p>The name of the namespace, such as <code>example.com</code>.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The type of the namespace. The methods for discovering instances depends on the value that you specify:</p>
    /// <dl>
    /// <dt>
    /// HTTP
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PUBLIC
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PRIVATE
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// </dl>
    pub fn r#type(&self) -> ::std::option::Option<&crate::types::NamespaceType> {
        self.r#type.as_ref()
    }
    /// <p>The description that you specify for the namespace when you create it.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The number of services that are associated with the namespace.</p>
    pub fn service_count(&self) -> ::std::option::Option<i32> {
        self.service_count
    }
    /// <p>A complex type that contains information that's specific to the type of the namespace.</p>
    pub fn properties(&self) -> ::std::option::Option<&crate::types::NamespaceProperties> {
        self.properties.as_ref()
    }
    /// <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    pub fn create_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.create_date.as_ref()
    }
    /// <p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.</p>
    pub fn creator_request_id(&self) -> ::std::option::Option<&str> {
        self.creator_request_id.as_deref()
    }
}
impl Namespace {
    /// Creates a new builder-style object to manufacture [`Namespace`](crate::types::Namespace).
    pub fn builder() -> crate::types::builders::NamespaceBuilder {
        crate::types::builders::NamespaceBuilder::default()
    }
}

/// A builder for [`Namespace`](crate::types::Namespace).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct NamespaceBuilder {
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) resource_owner: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) r#type: ::std::option::Option<crate::types::NamespaceType>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) service_count: ::std::option::Option<i32>,
    pub(crate) properties: ::std::option::Option<crate::types::NamespaceProperties>,
    pub(crate) create_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) creator_request_id: ::std::option::Option<::std::string::String>,
}
impl NamespaceBuilder {
    /// <p>The ID of a namespace.</p>
    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of a namespace.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The ID of a namespace.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</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 Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
    pub fn resource_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.resource_owner = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
    pub fn set_resource_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.resource_owner = input;
        self
    }
    /// <p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
    pub fn get_resource_owner(&self) -> &::std::option::Option<::std::string::String> {
        &self.resource_owner
    }
    /// <p>The name of the namespace, such as <code>example.com</code>.</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 namespace, such as <code>example.com</code>.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the namespace, such as <code>example.com</code>.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The type of the namespace. The methods for discovering instances depends on the value that you specify:</p>
    /// <dl>
    /// <dt>
    /// HTTP
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PUBLIC
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PRIVATE
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// </dl>
    pub fn r#type(mut self, input: crate::types::NamespaceType) -> Self {
        self.r#type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of the namespace. The methods for discovering instances depends on the value that you specify:</p>
    /// <dl>
    /// <dt>
    /// HTTP
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PUBLIC
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PRIVATE
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// </dl>
    pub fn set_type(mut self, input: ::std::option::Option<crate::types::NamespaceType>) -> Self {
        self.r#type = input;
        self
    }
    /// <p>The type of the namespace. The methods for discovering instances depends on the value that you specify:</p>
    /// <dl>
    /// <dt>
    /// HTTP
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PUBLIC
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// <dt>
    /// DNS_PRIVATE
    /// </dt>
    /// <dd>
    /// <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code> API.</p>
    /// </dd>
    /// </dl>
    pub fn get_type(&self) -> &::std::option::Option<crate::types::NamespaceType> {
        &self.r#type
    }
    /// <p>The description that you specify for the namespace when you create it.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The description that you specify for the namespace when you create it.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>The description that you specify for the namespace when you create it.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The number of services that are associated with the namespace.</p>
    pub fn service_count(mut self, input: i32) -> Self {
        self.service_count = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of services that are associated with the namespace.</p>
    pub fn set_service_count(mut self, input: ::std::option::Option<i32>) -> Self {
        self.service_count = input;
        self
    }
    /// <p>The number of services that are associated with the namespace.</p>
    pub fn get_service_count(&self) -> &::std::option::Option<i32> {
        &self.service_count
    }
    /// <p>A complex type that contains information that's specific to the type of the namespace.</p>
    pub fn properties(mut self, input: crate::types::NamespaceProperties) -> Self {
        self.properties = ::std::option::Option::Some(input);
        self
    }
    /// <p>A complex type that contains information that's specific to the type of the namespace.</p>
    pub fn set_properties(mut self, input: ::std::option::Option<crate::types::NamespaceProperties>) -> Self {
        self.properties = input;
        self
    }
    /// <p>A complex type that contains information that's specific to the type of the namespace.</p>
    pub fn get_properties(&self) -> &::std::option::Option<crate::types::NamespaceProperties> {
        &self.properties
    }
    /// <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    pub fn create_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.create_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    pub fn set_create_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.create_date = input;
        self
    }
    /// <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    pub fn get_create_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.create_date
    }
    /// <p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.</p>
    pub fn creator_request_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.creator_request_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.</p>
    pub fn set_creator_request_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.creator_request_id = input;
        self
    }
    /// <p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.</p>
    pub fn get_creator_request_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.creator_request_id
    }
    /// Consumes the builder and constructs a [`Namespace`](crate::types::Namespace).
    pub fn build(self) -> crate::types::Namespace {
        crate::types::Namespace {
            id: self.id,
            arn: self.arn,
            resource_owner: self.resource_owner,
            name: self.name,
            r#type: self.r#type,
            description: self.description,
            service_count: self.service_count,
            properties: self.properties,
            create_date: self.create_date,
            creator_request_id: self.creator_request_id,
        }
    }
}