Class: OCI::Identity::Models::MfaTotpDeviceSummary

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

Overview

As the name suggests, a MfaTotpDeviceSummary object contains information about a MfaTotpDevice.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MfaTotpDeviceSummary

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

  • :user_id (String)

    The value to assign to the #user_id property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_expires (DateTime)

    The value to assign to the #time_expires property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :inactive_status (Integer)

    The value to assign to the #inactive_status property

  • :is_activated (BOOLEAN)

    The value to assign to the #is_activated property



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 106

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

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

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

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

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

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

  self.time_expires = attributes[:'timeExpires'] if attributes[:'timeExpires']

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

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

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

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

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

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

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

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

  self.is_activated = attributes[:'isActivated'] unless attributes[:'isActivated'].nil?

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

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

Instance Attribute Details

#idString

[Required] The OCID of the MFA TOTP Device.

Returns:

  • (String)


23
24
25
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 23

def id
  @id
end

#inactive_statusInteger

The detailed status of INACTIVE lifecycleState. Allowed values are: - 1 - SUSPENDED - 2 - DISABLED - 4 - BLOCKED - 8 - LOCKED

Returns:

  • (Integer)


57
58
59
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 57

def inactive_status
  @inactive_status
end

#is_activatedBOOLEAN

[Required] Flag to indicate if the MFA TOTP device has been activated

Returns:

  • (BOOLEAN)


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

def is_activated
  @is_activated
end

#lifecycle_stateString

[Required] The MFA TOTP device's current state.

Returns:

  • (String)


47
48
49
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 47

def lifecycle_state
  @lifecycle_state
end

#time_createdDateTime

[Required] Date and time the MfaTotpDevice object was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime)


34
35
36
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 34

def time_created
  @time_created
end

#time_expiresDateTime

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

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

Returns:

  • (DateTime)


42
43
44
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 42

def time_expires
  @time_expires
end

#user_idString

[Required] The OCID of the user the MFA TOTP device belongs to.

Returns:

  • (String)


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

def user_id
  @user_id
end

Class Method Details

.attribute_mapObject

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



64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'user_id': :'userId',
    'time_created': :'timeCreated',
    'time_expires': :'timeExpires',
    'lifecycle_state': :'lifecycleState',
    'inactive_status': :'inactiveStatus',
    'is_activated': :'isActivated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'user_id': :'String',
    'time_created': :'DateTime',
    'time_expires': :'DateTime',
    'lifecycle_state': :'String',
    'inactive_status': :'Integer',
    'is_activated': :'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



171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 171

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

  self.class == other.class &&
    id == other.id &&
    user_id == other.user_id &&
    time_created == other.time_created &&
    time_expires == other.time_expires &&
    lifecycle_state == other.lifecycle_state &&
    inactive_status == other.inactive_status &&
    is_activated == other.is_activated
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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 207

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


187
188
189
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 187

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



196
197
198
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 196

def hash
  [id, user_id, time_created, time_expires, lifecycle_state, inactive_status, is_activated].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
249
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 240

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



234
235
236
# File 'lib/oci/identity/models/mfa_totp_device_summary.rb', line 234

def to_s
  to_hash.to_s
end