Class: OCI::Identity::Models::UIPassword

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

Overview

A text password that enables a user to sign in to the Console, the user interface for interacting with Oracle Cloud Infrastructure.

For more information about user credentials, see [User Credentials](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/usercredentials.htm).

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 = {}) ⇒ UIPassword

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :password (String) —

    The value to assign to the #password property

  • :userId (String) —

    The value to assign to the #user_id property

  • :timeCreated (DateTime) —

    The value to assign to the #time_created property

  • :lifecycleState (String) —

    The value to assign to the #lifecycle_state property

  • :inactiveStatus (Integer) —

    The value to assign to the #inactive_status property



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
 
# File 'lib/oci/identity/models/ui_password.rb', line 53

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

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

end

Instance Attribute Details

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/identity/models/ui_password.rb', line 43

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/identity/models/ui_password.rb', line 39

def lifecycle_state
  @lifecycle_state
end

#password ⇒ String

The user’s password for the Console.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/identity/models/ui_password.rb', line 22

def password
  @password
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


33
34
35
 
# File 'lib/oci/identity/models/ui_password.rb', line 33

def time_created
  @time_created
end

#user_id ⇒ String

The OCID of the user.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/identity/models/ui_password.rb', line 26

def user_id
  @user_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/identity/models/ui_password.rb', line 93

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      password == other_object.password &&
      user_id == other_object.user_id &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status
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/identity/models/ui_password.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/identity/models/ui_password.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/identity/models/ui_password.rb', line 111

def hash
  [password, user_id, time_created, lifecycle_state, inactive_status].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/identity/models/ui_password.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/identity/models/ui_password.rb', line 137

def to_s
  to_hash.to_s
end