Class: IntersightClient::SecurityUnit

Inherits:
EquipmentBase show all
Defined in:
lib/intersight_client/models/security_unit.rb

Overview

The crypto card present on a server.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from EquipmentBase

#model, #presence, #previous_fru, #revision, #serial, #vendor

Attributes inherited from InventoryBase

#device_mo_id, #dn, #rn

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityUnit

Initializes the object



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/intersight_client/models/security_unit.rb', line 151

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::SecurityUnit` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'security.Unit'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'security.Unit'
  end

  if attributes.key?(:'oper_state')
    self.oper_state = attributes[:'oper_state']
  end

  if attributes.key?(:'operability')
    self.operability = attributes[:'operability']
  end

  if attributes.key?(:'part_number')
    self.part_number = attributes[:'part_number']
  end

  if attributes.key?(:'pci_slot')
    self.pci_slot = attributes[:'pci_slot']
  end

  if attributes.key?(:'power')
    self.power = attributes[:'power']
  end

  if attributes.key?(:'thermal')
    self.thermal = attributes[:'thermal']
  end

  if attributes.key?(:'unit_id')
    self.unit_id = attributes[:'unit_id']
  end

  if attributes.key?(:'vid')
    self.vid = attributes[:'vid']
  end

  if attributes.key?(:'voltage')
    self.voltage = attributes[:'voltage']
  end

  if attributes.key?(:'compute_board')
    self.compute_board = attributes[:'compute_board']
  end

  if attributes.key?(:'inventory_device_info')
    self.inventory_device_info = attributes[:'inventory_device_info']
  end

  if attributes.key?(:'registered_device')
    self.registered_device = attributes[:'registered_device']
  end
end

Instance Attribute Details

#class_idObject

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
# File 'lib/intersight_client/models/security_unit.rb', line 20

def class_id
  @class_id
end

#compute_boardObject

Returns the value of attribute compute_board.



52
53
54
# File 'lib/intersight_client/models/security_unit.rb', line 52

def compute_board
  @compute_board
end

#inventory_device_infoObject

Returns the value of attribute inventory_device_info.



54
55
56
# File 'lib/intersight_client/models/security_unit.rb', line 54

def inventory_device_info
  @inventory_device_info
end

#object_typeObject

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
# File 'lib/intersight_client/models/security_unit.rb', line 23

def object_type
  @object_type
end

#oper_stateObject

Operational state of the security unit.



26
27
28
# File 'lib/intersight_client/models/security_unit.rb', line 26

def oper_state
  @oper_state
end

#operabilityObject

Operability state of the security unit.



29
30
31
# File 'lib/intersight_client/models/security_unit.rb', line 29

def operability
  @operability
end

#part_numberObject

The part number of the security unit.



32
33
34
# File 'lib/intersight_client/models/security_unit.rb', line 32

def part_number
  @part_number
end

#pci_slotObject

PCIe slot of the security unit in the server.



35
36
37
# File 'lib/intersight_client/models/security_unit.rb', line 35

def pci_slot
  @pci_slot
end

#powerObject

Power state of the security unit.



38
39
40
# File 'lib/intersight_client/models/security_unit.rb', line 38

def power
  @power
end

#registered_deviceObject

Returns the value of attribute registered_device.



56
57
58
# File 'lib/intersight_client/models/security_unit.rb', line 56

def registered_device
  @registered_device
end

#thermalObject

Thermal state of the security unit.



41
42
43
# File 'lib/intersight_client/models/security_unit.rb', line 41

def thermal
  @thermal
end

#unit_idObject

The unique identifier assigned to the security unit within the server.



44
45
46
# File 'lib/intersight_client/models/security_unit.rb', line 44

def unit_id
  @unit_id
end

#vidObject

The vendor identifier of the security unit.



47
48
49
# File 'lib/intersight_client/models/security_unit.rb', line 47

def vid
  @vid
end

#voltageObject

The voltage state of the security unit.



50
51
52
# File 'lib/intersight_client/models/security_unit.rb', line 50

def voltage
  @voltage
end

Class Method Details

.acceptable_attribute_mapObject

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



106
107
108
# File 'lib/intersight_client/models/security_unit.rb', line 106

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



101
102
103
# File 'lib/intersight_client/models/security_unit.rb', line 101

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_mapObject

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/intersight_client/models/security_unit.rb', line 81

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'oper_state' => :'OperState',
    :'operability' => :'Operability',
    :'part_number' => :'PartNumber',
    :'pci_slot' => :'PciSlot',
    :'power' => :'Power',
    :'thermal' => :'Thermal',
    :'unit_id' => :'UnitId',
    :'vid' => :'Vid',
    :'voltage' => :'Voltage',
    :'compute_board' => :'ComputeBoard',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'registered_device' => :'RegisteredDevice'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



311
312
313
# File 'lib/intersight_client/models/security_unit.rb', line 311

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



137
138
139
140
141
142
# File 'lib/intersight_client/models/security_unit.rb', line 137

def self.openapi_all_of
  [
  :'EquipmentBase',
  :'SecurityUnitAllOf'
  ]
end

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



145
146
147
# File 'lib/intersight_client/models/security_unit.rb', line 145

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



131
132
133
134
# File 'lib/intersight_client/models/security_unit.rb', line 131

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/intersight_client/models/security_unit.rb', line 111

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'oper_state' => :'String',
    :'operability' => :'String',
    :'part_number' => :'String',
    :'pci_slot' => :'String',
    :'power' => :'String',
    :'thermal' => :'String',
    :'unit_id' => :'Integer',
    :'vid' => :'String',
    :'voltage' => :'String',
    :'compute_board' => :'ComputeBoardRelationship',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/intersight_client/models/security_unit.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      oper_state == o.oper_state &&
      operability == o.operability &&
      part_number == o.part_number &&
      pci_slot == o.pci_slot &&
      power == o.power &&
      thermal == o.thermal &&
      unit_id == o.unit_id &&
      vid == o.vid &&
      voltage == o.voltage &&
      compute_board == o.compute_board &&
      inventory_device_info == o.inventory_device_info &&
      registered_device == o.registered_device && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/intersight_client/models/security_unit.rb', line 342

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/intersight_client/models/security_unit.rb', line 413

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/intersight_client/models/security_unit.rb', line 318

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  SecurityUnit.openapi_types.each_pair do |key, type|
    if attributes[SecurityUnit.attribute_map[key]].nil? && SecurityUnit.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[SecurityUnit.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[SecurityUnit.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[SecurityUnit.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[SecurityUnit.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


298
299
300
# File 'lib/intersight_client/models/security_unit.rb', line 298

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



304
305
306
# File 'lib/intersight_client/models/security_unit.rb', line 304

def hash
  [class_id, object_type, oper_state, operability, part_number, pci_slot, power, thermal, unit_id, vid, voltage, compute_board, inventory_device_info, registered_device].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?



230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/intersight_client/models/security_unit.rb', line 230

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



389
390
391
# File 'lib/intersight_client/models/security_unit.rb', line 389

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/intersight_client/models/security_unit.rb', line 395

def to_hash
  hash = super
  SecurityUnit.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = SecurityUnit.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object



383
384
385
# File 'lib/intersight_client/models/security_unit.rb', line 383

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid



245
246
247
248
249
250
251
252
253
# File 'lib/intersight_client/models/security_unit.rb', line 245

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["security.Unit"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["security.Unit"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end