class OCI::Email::Models::SuppressionSummary

The full information representing a suppression.

Constants

REASON_ENUM

Attributes

compartment_id[RW]

[Required] The OCID for the compartment. @return [String]

email_address[RW]

[Required] The email address of the suppression. @return [String]

id[RW]

[Required] The unique OCID of the suppression. @return [String]

reason[R]

The reason that the email address was suppressed. @return [String]

time_created[RW]

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.

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/email/models/suppression_summary.rb, line 45
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :email_address The value to assign to the {#email_address} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :reason The value to assign to the {#reason} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property

# File lib/oci/email/models/suppression_summary.rb, line 81
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/email/models/suppression_summary.rb, line 58
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/email/models/suppression_summary.rb, line 130
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/email/models/suppression_summary.rb, line 164
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/email/models/suppression_summary.rb, line 144
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/email/models/suppression_summary.rb, line 153
def hash
  [compartment_id, email_address, id, reason, time_created].hash
end
reason=(reason) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] reason Object to be assigned

# File lib/oci/email/models/suppression_summary.rb, line 114
def reason=(reason)
  # rubocop:disable Style/ConditionalAssignment
  if reason && !REASON_ENUM.include?(reason)
    OCI.logger.debug("Unknown value for 'reason' [" + reason + "]. Mapping to 'REASON_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @reason = REASON_UNKNOWN_ENUM_VALUE
  else
    @reason = reason
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/email/models/suppression_summary.rb, line 197
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/email/models/suppression_summary.rb, line 191
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/email/models/suppression_summary.rb, line 214
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end