Class: OCI::Email::Models::SuppressionSummary
- Inherits:
-
Object
- Object
- OCI::Email::Models::SuppressionSummary
- Defined in:
- lib/oci/email/models/suppression_summary.rb
Overview
The full information representing a suppression.
Constant Summary collapse
- REASON_ENUM =
[ REASON_UNKNOWN = 'UNKNOWN'.freeze, REASON_HARDBOUNCE = 'HARDBOUNCE'.freeze, REASON_COMPLAINT = 'COMPLAINT'.freeze, REASON_MANUAL = 'MANUAL'.freeze, REASON_SOFTBOUNCE = 'SOFTBOUNCE'.freeze, REASON_UNSUBSCRIBE = 'UNSUBSCRIBE'.freeze, REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID for the compartment.
-
#email_address ⇒ String
The email address of the suppression.
-
#id ⇒ String
The unique OCID of the suppression.
-
#reason ⇒ String
The reason that the email address was suppressed.
-
#time_created ⇒ DateTime
The date and time a recipient’s email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SuppressionSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SuppressionSummary
Initializes the object
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/oci/email/models/suppression_summary.rb', line 80 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.email_address = attributes[:'emailAddress'] if attributes[:'emailAddress'] raise 'You cannot provide both :emailAddress and :email_address' if attributes.key?(:'emailAddress') && attributes.key?(:'email_address') self.email_address = attributes[:'email_address'] if attributes[:'email_address'] self.id = attributes[:'id'] if attributes[:'id'] self.reason = attributes[:'reason'] if attributes[:'reason'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] end |
Instance Attribute Details
#compartment_id ⇒ String
The OCID for the compartment.
22 23 24 |
# File 'lib/oci/email/models/suppression_summary.rb', line 22 def compartment_id @compartment_id end |
#email_address ⇒ String
The email address of the suppression.
26 27 28 |
# File 'lib/oci/email/models/suppression_summary.rb', line 26 def email_address @email_address end |
#id ⇒ String
The unique OCID of the suppression.
30 31 32 |
# File 'lib/oci/email/models/suppression_summary.rb', line 30 def id @id end |
#reason ⇒ String
The reason that the email address was suppressed.
34 35 36 |
# File 'lib/oci/email/models/suppression_summary.rb', line 34 def reason @reason end |
#time_created ⇒ DateTime
The date and time a recipient’s email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
41 42 43 |
# File 'lib/oci/email/models/suppression_summary.rb', line 41 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/oci/email/models/suppression_summary.rb', line 44 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'email_address': :'emailAddress', 'id': :'id', 'reason': :'reason', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/oci/email/models/suppression_summary.rb', line 57 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'email_address': :'String', 'id': :'String', 'reason': :'String', 'time_created': :'DateTime' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
129 130 131 132 133 134 135 136 137 138 |
# File 'lib/oci/email/models/suppression_summary.rb', line 129 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && email_address == other.email_address && id == other.id && reason == other.reason && time_created == other.time_created end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/oci/email/models/suppression_summary.rb', line 163 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
143 144 145 |
# File 'lib/oci/email/models/suppression_summary.rb', line 143 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
152 153 154 |
# File 'lib/oci/email/models/suppression_summary.rb', line 152 def hash [compartment_id, email_address, id, reason, time_created].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
196 197 198 199 200 201 202 203 204 205 |
# File 'lib/oci/email/models/suppression_summary.rb', line 196 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
190 191 192 |
# File 'lib/oci/email/models/suppression_summary.rb', line 190 def to_s to_hash.to_s end |