File: //usr/lib/mysqlsh/lib/python3.8/site-packages/oci/email/models/create_email_domain_details.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20170907
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class CreateEmailDomainDetails(object):
"""
The configuration details for creating a new email domain.
"""
def __init__(self, **kwargs):
"""
Initializes a new CreateEmailDomainDetails object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param name:
The value to assign to the name property of this CreateEmailDomainDetails.
:type name: str
:param compartment_id:
The value to assign to the compartment_id property of this CreateEmailDomainDetails.
:type compartment_id: str
:param domain_verification_id:
The value to assign to the domain_verification_id property of this CreateEmailDomainDetails.
:type domain_verification_id: str
:param description:
The value to assign to the description property of this CreateEmailDomainDetails.
:type description: str
:param freeform_tags:
The value to assign to the freeform_tags property of this CreateEmailDomainDetails.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this CreateEmailDomainDetails.
:type defined_tags: dict(str, dict(str, object))
"""
self.swagger_types = {
'name': 'str',
'compartment_id': 'str',
'domain_verification_id': 'str',
'description': 'str',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))'
}
self.attribute_map = {
'name': 'name',
'compartment_id': 'compartmentId',
'domain_verification_id': 'domainVerificationId',
'description': 'description',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags'
}
self._name = None
self._compartment_id = None
self._domain_verification_id = None
self._description = None
self._freeform_tags = None
self._defined_tags = None
@property
def name(self):
"""
**[Required]** Gets the name of this CreateEmailDomainDetails.
The name of the email domain in the Internet Domain Name System (DNS).
The email domain name must be unique in the region for this tenancy.
Domain names limited to ASCII characters use alphanumeric, dash (\"-\"), and dot (\".\") characters.
The dash and dot are only allowed between alphanumeric characters.
For details, see `RFC 5321, section 4.1.2`__
Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).
__ https://tools.ietf.org/html/rfc5321#section-4.1.2
:return: The name of this CreateEmailDomainDetails.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this CreateEmailDomainDetails.
The name of the email domain in the Internet Domain Name System (DNS).
The email domain name must be unique in the region for this tenancy.
Domain names limited to ASCII characters use alphanumeric, dash (\"-\"), and dot (\".\") characters.
The dash and dot are only allowed between alphanumeric characters.
For details, see `RFC 5321, section 4.1.2`__
Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).
__ https://tools.ietf.org/html/rfc5321#section-4.1.2
:param name: The name of this CreateEmailDomainDetails.
:type: str
"""
self._name = name
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this CreateEmailDomainDetails.
The `OCID`__ of the compartment for this email domain.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this CreateEmailDomainDetails.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this CreateEmailDomainDetails.
The `OCID`__ of the compartment for this email domain.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this CreateEmailDomainDetails.
:type: str
"""
self._compartment_id = compartment_id
@property
def domain_verification_id(self):
"""
Gets the domain_verification_id of this CreateEmailDomainDetails.
Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
:return: The domain_verification_id of this CreateEmailDomainDetails.
:rtype: str
"""
return self._domain_verification_id
@domain_verification_id.setter
def domain_verification_id(self, domain_verification_id):
"""
Sets the domain_verification_id of this CreateEmailDomainDetails.
Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
:param domain_verification_id: The domain_verification_id of this CreateEmailDomainDetails.
:type: str
"""
self._domain_verification_id = domain_verification_id
@property
def description(self):
"""
Gets the description of this CreateEmailDomainDetails.
A string that describes the details about the domain. It does not have to be unique,
and you can change it. Avoid entering confidential information.
:return: The description of this CreateEmailDomainDetails.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this CreateEmailDomainDetails.
A string that describes the details about the domain. It does not have to be unique,
and you can change it. Avoid entering confidential information.
:param description: The description of this CreateEmailDomainDetails.
:type: str
"""
self._description = description
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this CreateEmailDomainDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this CreateEmailDomainDetails.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this CreateEmailDomainDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this CreateEmailDomainDetails.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this CreateEmailDomainDetails.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this CreateEmailDomainDetails.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this CreateEmailDomainDetails.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this CreateEmailDomainDetails.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other