Class: OCI::IdentityDataPlane::Models::User

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

Overview

User model.

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):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :is_otp (BOOLEAN) —

    The value to assign to the #is_otp property

  • :is_mfa_activated (BOOLEAN) —

    The value to assign to the #is_mfa_activated property

  • :is_mfa_verified (BOOLEAN) —

    The value to assign to the #is_mfa_verified property



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
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 69

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

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

  self.is_otp = attributes[:'isOTP'] unless attributes[:'isOTP'].nil?

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

  self.is_otp = attributes[:'is_otp'] unless attributes[:'is_otp'].nil?

  self.is_mfa_activated = attributes[:'isMfaActivated'] unless attributes[:'isMfaActivated'].nil?

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

  self.is_mfa_activated = attributes[:'is_mfa_activated'] unless attributes[:'is_mfa_activated'].nil?

  self.is_mfa_verified = attributes[:'isMfaVerified'] unless attributes[:'isMfaVerified'].nil?

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

  self.is_mfa_verified = attributes[:'is_mfa_verified'] unless attributes[:'is_mfa_verified'].nil?
end

Instance Attribute Details

#id ⇒ String

[Required] The user's Oracle ID (OCID).

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 14

def id
  @id
end

#is_mfa_activated ⇒ BOOLEAN

[Required] If mfa is activated.

Returns:

  • (BOOLEAN) 


26
27
28
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 26

def is_mfa_activated
  @is_mfa_activated
end

#is_mfa_verified ⇒ BOOLEAN

[Required] If the user has been mfa verified.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 30

def is_mfa_verified
  @is_mfa_verified
end

#is_otp ⇒ BOOLEAN

[Required] If the provided password is a one-time password.

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 22

def is_otp
  @is_otp
end

#name ⇒ String

[Required] The name of the user.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 18

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'is_otp': :'isOTP',
    'is_mfa_activated': :'isMfaActivated',
    'is_mfa_verified': :'isMfaVerified'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'is_otp': :'BOOLEAN',
    'is_mfa_activated': :'BOOLEAN',
    'is_mfa_verified': :'BOOLEAN'
    # 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



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 105

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    is_otp == other.is_otp &&
    is_mfa_activated == other.is_mfa_activated &&
    is_mfa_verified == other.is_mfa_verified
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 139

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


119
120
121
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 128

def hash
  [id, name, is_otp, is_mfa_activated, is_mfa_verified].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 172

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



166
167
168
 
# File 'lib/oci/identity_data_plane/models/user.rb', line 166

def to_s
  to_hash.to_s
end