Class: OCI::Cims::Models::User

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cims/models/user.rb

Overview

Details about the user.

Constant Summary collapse

PROBLEM_TYPE_ENUM = 
[
  PROBLEM_TYPE_LIMIT = 'LIMIT'.freeze,
  PROBLEM_TYPE_LEGACY_LIMIT = 'LEGACY_LIMIT'.freeze,
  PROBLEM_TYPE_TECH = 'TECH'.freeze,
  PROBLEM_TYPE_ACCOUNT = 'ACCOUNT'.freeze,
  PROBLEM_TYPE_TAXONOMY = 'TAXONOMY'.freeze,
  PROBLEM_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :first_name (String) —

    The value to assign to the #first_name property

  • :last_name (String) —

    The value to assign to the #last_name property

  • :country (String) —

    The value to assign to the #country property

  • :csi (String) —

    The value to assign to the #csi property

  • :phone (String) —

    The value to assign to the #phone property

  • :timezone (String) —

    The value to assign to the #timezone property

  • :organization_name (String) —

    The value to assign to the #organization_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :contact_email (String) —

    The value to assign to the #contact_email property

  • :problem_type (String) —

    The value to assign to the #problem_type property



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/cims/models/user.rb', line 120

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

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

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

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

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

  self.organization_name = attributes[:'organizationName'] if attributes[:'organizationName']

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

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

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

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

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

  self.problem_type = attributes[:'problemType'] if attributes[:'problemType']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/cims/models/user.rb', line 55

def compartment_id
  @compartment_id
end

#contact_email ⇒ String

The email of the contact person.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/cims/models/user.rb', line 59

def contact_email
  @contact_email
end

#country ⇒ String

The country of the user.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/cims/models/user.rb', line 35

def country
  @country
end

#csi ⇒ String

The CSI associated with the user.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/cims/models/user.rb', line 39

def csi
  @csi
end

#first_name ⇒ String

The user's first name.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/cims/models/user.rb', line 27

def first_name
  @first_name
end

#key ⇒ String

[Required] A unique identifier for the user.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/cims/models/user.rb', line 23

def key
  @key
end

#last_name ⇒ String

The user's last name.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/cims/models/user.rb', line 31

def last_name
  @last_name
end

#organization_name ⇒ String

The company that the user belongs to.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/cims/models/user.rb', line 51

def organization_name
  @organization_name
end

#phone ⇒ String

The user's contact phone number.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/cims/models/user.rb', line 43

def phone
  @phone
end

#problem_type ⇒ String

The kind of support ticket, such as a technical support request or a limit increase request.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/cims/models/user.rb', line 63

def problem_type
  @problem_type
end

#timezone ⇒ String

The timezone of the user.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/cims/models/user.rb', line 47

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/cims/models/user.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'first_name': :'firstName',
    'last_name': :'lastName',
    'country': :'country',
    'csi': :'csi',
    'phone': :'phone',
    'timezone': :'timezone',
    'organization_name': :'organizationName',
    'compartment_id': :'compartmentId',
    'contact_email': :'contactEmail',
    'problem_type': :'problemType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/cims/models/user.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'first_name': :'String',
    'last_name': :'String',
    'country': :'String',
    'csi': :'String',
    'phone': :'String',
    'timezone': :'String',
    'organization_name': :'String',
    'compartment_id': :'String',
    'contact_email': :'String',
    'problem_type': :'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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/cims/models/user.rb', line 193

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

  self.class == other.class &&
    key == other.key &&
    first_name == other.first_name &&
    last_name == other.last_name &&
    country == other.country &&
    csi == other.csi &&
    phone == other.phone &&
    timezone == other.timezone &&
    organization_name == other.organization_name &&
    compartment_id == other.compartment_id &&
    contact_email == other.contact_email &&
    problem_type == other.problem_type
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/cims/models/user.rb', line 233

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


213
214
215
 
# File 'lib/oci/cims/models/user.rb', line 213

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/oci/cims/models/user.rb', line 222

def hash
  [key, first_name, last_name, country, csi, phone, timezone, organization_name, compartment_id, contact_email, problem_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/cims/models/user.rb', line 266

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



260
261
262
 
# File 'lib/oci/cims/models/user.rb', line 260

def to_s
  to_hash.to_s
end