Class: OCI::Email::Models::SenderSummary

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

Overview

The email addresses and ‘senderId` representing an approved sender.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SenderSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :email_address (String) —

    The value to assign to the #email_address property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/email/models/sender_summary.rb', line 40

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[:'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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

end

Instance Attribute Details

#email_address ⇒ String

The email address of the sender.

Returns:

  • (String) 


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

def email_address
  @email_address
end

#id ⇒ String

The unique ID of the sender.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/email/models/sender_summary.rb', line 21

def id
  @id
end

#lifecycle_state ⇒ String

The current status of the approved sender.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/email/models/sender_summary.rb', line 25

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

Date time the approved sender was added, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/oci/email/models/sender_summary.rb', line 31

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



94
95
96
97
98
99
100
101
 
# File 'lib/oci/email/models/sender_summary.rb', line 94

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      email_address == other_object.email_address &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      time_created == other_object.time_created
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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/email/models/sender_summary.rb', line 118

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


105
106
107
 
# File 'lib/oci/email/models/sender_summary.rb', line 105

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



111
112
113
 
# File 'lib/oci/email/models/sender_summary.rb', line 111

def hash
  [email_address, id, lifecycle_state, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/email/models/sender_summary.rb', line 143

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



137
138
139
 
# File 'lib/oci/email/models/sender_summary.rb', line 137

def to_s
  to_hash.to_s
end