Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/usr/share/mysqlsh/oci_sdk/oci/email/models/ |
# coding: utf-8
# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
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 Suppression(object):
"""
The full information representing an email suppression.
"""
#: A constant which can be used with the reason property of a Suppression.
#: This constant has a value of "UNKNOWN"
REASON_UNKNOWN = "UNKNOWN"
#: A constant which can be used with the reason property of a Suppression.
#: This constant has a value of "HARDBOUNCE"
REASON_HARDBOUNCE = "HARDBOUNCE"
#: A constant which can be used with the reason property of a Suppression.
#: This constant has a value of "COMPLAINT"
REASON_COMPLAINT = "COMPLAINT"
#: A constant which can be used with the reason property of a Suppression.
#: This constant has a value of "MANUAL"
REASON_MANUAL = "MANUAL"
#: A constant which can be used with the reason property of a Suppression.
#: This constant has a value of "SOFTBOUNCE"
REASON_SOFTBOUNCE = "SOFTBOUNCE"
#: A constant which can be used with the reason property of a Suppression.
#: This constant has a value of "UNSUBSCRIBE"
REASON_UNSUBSCRIBE = "UNSUBSCRIBE"
def __init__(self, **kwargs):
"""
Initializes a new Suppression object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param compartment_id:
The value to assign to the compartment_id property of this Suppression.
:type compartment_id: str
:param email_address:
The value to assign to the email_address property of this Suppression.
:type email_address: str
:param id:
The value to assign to the id property of this Suppression.
:type id: str
:param reason:
The value to assign to the reason property of this Suppression.
Allowed values for this property are: "UNKNOWN", "HARDBOUNCE", "COMPLAINT", "MANUAL", "SOFTBOUNCE", "UNSUBSCRIBE", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type reason: str
:param time_created:
The value to assign to the time_created property of this Suppression.
:type time_created: datetime
"""
self.swagger_types = {
'compartment_id': 'str',
'email_address': 'str',
'id': 'str',
'reason': 'str',
'time_created': 'datetime'
}
self.attribute_map = {
'compartment_id': 'compartmentId',
'email_address': 'emailAddress',
'id': 'id',
'reason': 'reason',
'time_created': 'timeCreated'
}
self._compartment_id = None
self._email_address = None
self._id = None
self._reason = None
self._time_created = None
@property
def compartment_id(self):
"""
Gets the compartment_id of this Suppression.
The OCID of the compartment to contain the suppression. Since
suppressions are at the customer level, this must be the tenancy
OCID.
:return: The compartment_id of this Suppression.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this Suppression.
The OCID of the compartment to contain the suppression. Since
suppressions are at the customer level, this must be the tenancy
OCID.
:param compartment_id: The compartment_id of this Suppression.
:type: str
"""
self._compartment_id = compartment_id
@property
def email_address(self):
"""
Gets the email_address of this Suppression.
Email address of the suppression.
:return: The email_address of this Suppression.
:rtype: str
"""
return self._email_address
@email_address.setter
def email_address(self, email_address):
"""
Sets the email_address of this Suppression.
Email address of the suppression.
:param email_address: The email_address of this Suppression.
:type: str
"""
self._email_address = email_address
@property
def id(self):
"""
Gets the id of this Suppression.
The unique ID of the suppression.
:return: The id of this Suppression.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this Suppression.
The unique ID of the suppression.
:param id: The id of this Suppression.
:type: str
"""
self._id = id
@property
def reason(self):
"""
Gets the reason of this Suppression.
The reason that the email address was suppressed. For more information on the types of bounces, see `Suppression List`__.
__ https://docs.cloud.oracle.com/Content/Email/Concepts/overview.htm#components
Allowed values for this property are: "UNKNOWN", "HARDBOUNCE", "COMPLAINT", "MANUAL", "SOFTBOUNCE", "UNSUBSCRIBE", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The reason of this Suppression.
:rtype: str
"""
return self._reason
@reason.setter
def reason(self, reason):
"""
Sets the reason of this Suppression.
The reason that the email address was suppressed. For more information on the types of bounces, see `Suppression List`__.
__ https://docs.cloud.oracle.com/Content/Email/Concepts/overview.htm#components
:param reason: The reason of this Suppression.
:type: str
"""
allowed_values = ["UNKNOWN", "HARDBOUNCE", "COMPLAINT", "MANUAL", "SOFTBOUNCE", "UNSUBSCRIBE"]
if not value_allowed_none_or_none_sentinel(reason, allowed_values):
reason = 'UNKNOWN_ENUM_VALUE'
self._reason = reason
@property
def time_created(self):
"""
Gets the time_created of this Suppression.
The date and time the suppression was added in \"YYYY-MM-ddThh:mmZ\"
format with a Z offset, as defined by RFC 3339.
:return: The time_created of this Suppression.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this Suppression.
The date and time the suppression was added in \"YYYY-MM-ddThh:mmZ\"
format with a Z offset, as defined by RFC 3339.
:param time_created: The time_created of this Suppression.
:type: datetime
"""
self._time_created = time_created
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