File: //usr/lib/mysqlsh/lib/python3.8/site-packages/oci/email/models/dkim_summary.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 DkimSummary(object):
"""
The properties that define a DKIM.
"""
def __init__(self, **kwargs):
"""
Initializes a new DkimSummary 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 DkimSummary.
:type name: str
:param id:
The value to assign to the id property of this DkimSummary.
:type id: str
:param email_domain_id:
The value to assign to the email_domain_id property of this DkimSummary.
:type email_domain_id: str
:param compartment_id:
The value to assign to the compartment_id property of this DkimSummary.
:type compartment_id: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this DkimSummary.
:type lifecycle_state: str
:param description:
The value to assign to the description property of this DkimSummary.
:type description: str
:param time_created:
The value to assign to the time_created property of this DkimSummary.
:type time_created: datetime
:param time_updated:
The value to assign to the time_updated property of this DkimSummary.
:type time_updated: datetime
:param is_imported:
The value to assign to the is_imported property of this DkimSummary.
:type is_imported: bool
:param key_length:
The value to assign to the key_length property of this DkimSummary.
:type key_length: int
:param freeform_tags:
The value to assign to the freeform_tags property of this DkimSummary.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this DkimSummary.
:type defined_tags: dict(str, dict(str, object))
:param system_tags:
The value to assign to the system_tags property of this DkimSummary.
:type system_tags: dict(str, dict(str, object))
"""
self.swagger_types = {
'name': 'str',
'id': 'str',
'email_domain_id': 'str',
'compartment_id': 'str',
'lifecycle_state': 'str',
'description': 'str',
'time_created': 'datetime',
'time_updated': 'datetime',
'is_imported': 'bool',
'key_length': 'int',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'system_tags': 'dict(str, dict(str, object))'
}
self.attribute_map = {
'name': 'name',
'id': 'id',
'email_domain_id': 'emailDomainId',
'compartment_id': 'compartmentId',
'lifecycle_state': 'lifecycleState',
'description': 'description',
'time_created': 'timeCreated',
'time_updated': 'timeUpdated',
'is_imported': 'isImported',
'key_length': 'keyLength',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags',
'system_tags': 'systemTags'
}
self._name = None
self._id = None
self._email_domain_id = None
self._compartment_id = None
self._lifecycle_state = None
self._description = None
self._time_created = None
self._time_updated = None
self._is_imported = None
self._key_length = None
self._freeform_tags = None
self._defined_tags = None
self._system_tags = None
@property
def name(self):
"""
**[Required]** Gets the name of this DkimSummary.
The DKIM selector. This selector is required to be globally unique for this email domain.
:return: The name of this DkimSummary.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this DkimSummary.
The DKIM selector. This selector is required to be globally unique for this email domain.
:param name: The name of this DkimSummary.
:type: str
"""
self._name = name
@property
def id(self):
"""
**[Required]** Gets the id of this DkimSummary.
The `OCID`__ of the DKIM.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The id of this DkimSummary.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DkimSummary.
The `OCID`__ of the DKIM.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param id: The id of this DkimSummary.
:type: str
"""
self._id = id
@property
def email_domain_id(self):
"""
**[Required]** Gets the email_domain_id of this DkimSummary.
The `OCID`__ of the email domain
that this DKIM belongs to.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The email_domain_id of this DkimSummary.
:rtype: str
"""
return self._email_domain_id
@email_domain_id.setter
def email_domain_id(self, email_domain_id):
"""
Sets the email_domain_id of this DkimSummary.
The `OCID`__ of the email domain
that this DKIM belongs to.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param email_domain_id: The email_domain_id of this DkimSummary.
:type: str
"""
self._email_domain_id = email_domain_id
@property
def compartment_id(self):
"""
Gets the compartment_id of this DkimSummary.
The `OCID`__ of the compartment that contains this DKIM.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this DkimSummary.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this DkimSummary.
The `OCID`__ of the compartment that contains this DKIM.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this DkimSummary.
:type: str
"""
self._compartment_id = compartment_id
@property
def lifecycle_state(self):
"""
Gets the lifecycle_state of this DkimSummary.
The current state of the DKIM.
:return: The lifecycle_state of this DkimSummary.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this DkimSummary.
The current state of the DKIM.
:param lifecycle_state: The lifecycle_state of this DkimSummary.
:type: str
"""
self._lifecycle_state = lifecycle_state
@property
def description(self):
"""
Gets the description of this DkimSummary.
The description of a DKIM. Avoid entering confidential information.
:return: The description of this DkimSummary.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DkimSummary.
The description of a DKIM. Avoid entering confidential information.
:param description: The description of this DkimSummary.
:type: str
"""
self._description = description
@property
def time_created(self):
"""
Gets the time_created of this DkimSummary.
The time the DKIM was created.
Times are expressed in `RFC 3339`__
timestamp format, \"YYYY-MM-ddThh:mmZ\".
Example: `2021-02-12T22:47:12.613Z`
__ https://tools.ietf.org/html/rfc3339
:return: The time_created of this DkimSummary.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this DkimSummary.
The time the DKIM was created.
Times are expressed in `RFC 3339`__
timestamp format, \"YYYY-MM-ddThh:mmZ\".
Example: `2021-02-12T22:47:12.613Z`
__ https://tools.ietf.org/html/rfc3339
:param time_created: The time_created of this DkimSummary.
:type: datetime
"""
self._time_created = time_created
@property
def time_updated(self):
"""
Gets the time_updated of this DkimSummary.
The time of the last change to the DKIM configuration, due to a state change or
an update operation.
Times are expressed in `RFC 3339`__
timestamp format, \"YYYY-MM-ddThh:mmZ\".
__ https://tools.ietf.org/html/rfc3339
:return: The time_updated of this DkimSummary.
:rtype: datetime
"""
return self._time_updated
@time_updated.setter
def time_updated(self, time_updated):
"""
Sets the time_updated of this DkimSummary.
The time of the last change to the DKIM configuration, due to a state change or
an update operation.
Times are expressed in `RFC 3339`__
timestamp format, \"YYYY-MM-ddThh:mmZ\".
__ https://tools.ietf.org/html/rfc3339
:param time_updated: The time_updated of this DkimSummary.
:type: datetime
"""
self._time_updated = time_updated
@property
def is_imported(self):
"""
Gets the is_imported of this DkimSummary.
Indicates whether the DKIM was imported.
:return: The is_imported of this DkimSummary.
:rtype: bool
"""
return self._is_imported
@is_imported.setter
def is_imported(self, is_imported):
"""
Sets the is_imported of this DkimSummary.
Indicates whether the DKIM was imported.
:param is_imported: The is_imported of this DkimSummary.
:type: bool
"""
self._is_imported = is_imported
@property
def key_length(self):
"""
Gets the key_length of this DkimSummary.
Length of the RSA key used in the DKIM.
:return: The key_length of this DkimSummary.
:rtype: int
"""
return self._key_length
@key_length.setter
def key_length(self, key_length):
"""
Sets the key_length of this DkimSummary.
Length of the RSA key used in the DKIM.
:param key_length: The key_length of this DkimSummary.
:type: int
"""
self._key_length = key_length
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this DkimSummary.
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 DkimSummary.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this DkimSummary.
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 DkimSummary.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this DkimSummary.
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 DkimSummary.
: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 DkimSummary.
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 DkimSummary.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def system_tags(self):
"""
Gets the system_tags of this DkimSummary.
Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
:return: The system_tags of this DkimSummary.
:rtype: dict(str, dict(str, object))
"""
return self._system_tags
@system_tags.setter
def system_tags(self, system_tags):
"""
Sets the system_tags of this DkimSummary.
Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
:param system_tags: The system_tags of this DkimSummary.
:type: dict(str, dict(str, object))
"""
self._system_tags = system_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