Class: OCI::Email::Models::CreateSuppressionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/email/models/create_suppression_details.rb

Overview

The details needed for creating a single suppression.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSuppressionDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :email_address (String) —

    The value to assign to the #email_address property



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 24

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}

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  if attributes[:'compartment_id']
    self.compartment_id = attributes[:'compartment_id']
  end

  if attributes[:'emailAddress']
    self.email_address = attributes[:'emailAddress']
  end

  raise 'You cannot provide both :emailAddress and :email_address' if attributes.key?(:'emailAddress') && attributes.key?(:'email_address')

  if attributes[:'email_address']
    self.email_address = attributes[:'email_address']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 13

def compartment_id
  @compartment_id
end

#email_address ⇒ String

The recipient email address of the suppression.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 17

def email_address
  @email_address
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



54
55
56
57
58
59
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 54

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      email_address == other_object.email_address
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 76

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


63
64
65
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 63

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



69
70
71
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 69

def hash
  [compartment_id, email_address].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 101

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

Returns:

  • (String) —

    String presentation of the object



95
96
97
 
# File 'lib/oci/email/models/create_suppression_details.rb', line 95

def to_s
  to_hash.to_s
end