Class: OCI::UsageApi::Models::EmailRecipient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/usage_api/models/email_recipient.rb

Overview

The email recipient to receive usage statements for the subscription.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailRecipient

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :first_name (String) —

    The value to assign to the #first_name property

  • :last_name (String) —

    The value to assign to the #last_name property

  • :email_id (String) —

    The value to assign to the #email_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 68

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.first_name = attributes[:'firstName'] if attributes[:'firstName']

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

  self.first_name = attributes[:'first_name'] if attributes[:'first_name']

  self.last_name = attributes[:'lastName'] if attributes[:'lastName']

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

  self.last_name = attributes[:'last_name'] if attributes[:'last_name']

  self.email_id = attributes[:'emailId'] if attributes[:'emailId']

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

  self.email_id = attributes[:'email_id'] if attributes[:'email_id']

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

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

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

Instance Attribute Details

#email_id ⇒ String

[Required] the email of the recipient.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 28

def email_id
  @email_id
end

#first_name ⇒ String

the first name of the recipient.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 20

def first_name
  @first_name
end

#last_name ⇒ String

the last name of the recipient.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 24

def last_name
  @last_name
end

#lifecycle_state ⇒ String

[Required] The email recipient lifecycle state.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 32

def lifecycle_state
  @lifecycle_state
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'first_name': :'firstName',
    'last_name': :'lastName',
    'email_id': :'emailId',
    'lifecycle_state': :'lifecycleState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'first_name': :'String',
    'last_name': :'String',
    'email_id': :'String',
    'lifecycle_state': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 119

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    first_name == other.first_name &&
    last_name == other.last_name &&
    email_id == other.email_id &&
    lifecycle_state == other.lifecycle_state
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 152

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


132
133
134
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 141

def hash
  [first_name, last_name, email_id, lifecycle_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 185

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



179
180
181
 
# File 'lib/oci/usage_api/models/email_recipient.rb', line 179

def to_s
  to_hash.to_s
end