Class: OracleBMC::Identity::Models::SwiftPassword

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/identity/models/swift_password.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 = {}) ⇒ SwiftPassword

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
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
98
99
100
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 61

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'userId']
    self.user_id = attributes[:'userId']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
  if attributes[:'expiresOn']
    self.expires_on = attributes[:'expiresOn']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'inactiveStatus']
    self.inactive_status = attributes[:'inactiveStatus']
  end
  
end

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 31

def description
  @description
end

#expires_on ⇒ DateTime

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires.

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

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 46

def expires_on
  @expires_on
end

#id ⇒ String

The OCID of the Swift password.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 23

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 56

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) 


52
53
54
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 52

def lifecycle_state
  @lifecycle_state
end

#password ⇒ String

The Swift password. The value is available only in the response for ‘CreateSwiftPassword`, and not for `ListSwiftPasswords` or `UpdateSwiftPassword`.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 19

def password
  @password
end

#time_created ⇒ DateTime

Date and time the ‘SwiftPassword` object was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 38

def time_created
  @time_created
end

#user_id ⇒ String

The OCID of the user the password belongs to.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 27

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



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 114

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      password == other_object.password &&
      id == other_object.id &&
      user_id == other_object.user_id &&
      description == other_object.description &&
      time_created == other_object.time_created &&
      expires_on == other_object.expires_on &&
      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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 142

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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


129
130
131
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 129

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 135

def hash
  [password, id, user_id, description, time_created, expires_on, 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



167
168
169
170
171
172
173
174
175
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 167

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



161
162
163
 
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 161

def to_s
  to_hash.to_s
end