Class: OCI::Identity::Models::User

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_INACTIVE = 'INACTIVE',
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 = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/identity/models/user.rb', line 72

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

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

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

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

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

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

  if attributes[:'inactiveStatus']
    self.inactive_status = attributes[:'inactiveStatus']
  end

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy containing the user.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/identity/models/user.rb', line 21

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: ‘{"bar-key": "foo-value"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


67
68
69
 
# File 'lib/oci/identity/models/user.rb', line 67

def defined_tags
  @defined_tags
end

#description ⇒ String

The description you assign to the user. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


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

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists solely for compatibility with other cloud provider tagging schemes. Example: ‘"value"`

Returns:

  • (Hash<String, String>) 


61
62
63
 
# File 'lib/oci/identity/models/user.rb', line 61

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the user.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/identity/models/user.rb', line 17

def id
  @id
end

#inactive_status ⇒ Integer

Returned only if the user’s ‘lifecycleState` is INACTIVE. A 16-bit value showing the reason why the user is inactive:

  • bit 0: SUSPENDED (reserved for future use)

  • bit 1: DISABLED (reserved for future use)

  • bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console)

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/oci/identity/models/user.rb', line 54

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

The user’s current state. After creating a user, make sure its ‘lifecycleState` changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/identity/models/user.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

The name you assign to the user during creation. This is the user’s login for the Console. The name must be unique across all users in the tenancy and cannot be changed.

Returns:

  • (String) 


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

def name
  @name
end

#time_created ⇒ DateTime

Date and time the user was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/identity/models/user.rb', line 38

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



128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/identity/models/user.rb', line 128

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      description == other_object.description &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags
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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/identity/models/user.rb', line 157

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


144
145
146
 
# File 'lib/oci/identity/models/user.rb', line 144

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/oci/identity/models/user.rb', line 150

def hash
  [id, compartment_id, name, description, time_created, lifecycle_state, inactive_status, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/identity/models/user.rb', line 182

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



176
177
178
 
# File 'lib/oci/identity/models/user.rb', line 176

def to_s
  to_hash.to_s
end