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']

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



60
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
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 60

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

#descriptionString

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

Returns:

  • (String)


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

def description
  @description
end

#expires_onDateTime

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)


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

def expires_on
  @expires_on
end

#idString

The OCID of the Swift password.

Returns:

  • (String)


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

def id
  @id
end

#inactive_statusInteger

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer)


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

def inactive_status
  @inactive_status
end

#lifecycle_stateString

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

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#passwordString

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

Returns:

  • (String)


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

def password
  @password
end

#time_createdDateTime

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

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#user_idString

The OCID of the user the password belongs to.

Returns:

  • (String)


26
27
28
# File 'lib/oraclebmc/identity/models/swift_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



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

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



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

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


127
128
129
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 127

def eql?(other_object)
  self == other_object
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



133
134
135
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 133

def hash
  [password, id, user_id, description, time_created, expires_on, lifecycle_state, inactive_status].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



159
160
161
# File 'lib/oraclebmc/identity/models/swift_password.rb', line 159

def to_s
  to_hash.to_s
end