Class: IntersightClient::EquipmentFanModule

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

Overview

This represents Fan module housing multiple fans for chassis/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 = {}) ⇒ EquipmentFanModule

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 177

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::EquipmentFanModule` 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 = 'equipment.FanModule'
  end

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

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

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

  if attributes.key?(:'oper_reason')
    if (value = attributes[:'oper_reason']).is_a?(Array)
      self.oper_reason = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'fans')
    if (value = attributes[:'fans']).is_a?(Array)
      self.fans = value
    end
  end

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

  if attributes.key?(:'network_element')
    self.network_element = attributes[:'network_element']
  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/equipment_fan_module.rb', line 20

def class_id
  @class_id
end

#compute_rack_unitObject

Returns the value of attribute compute_rack_unit.



51
52
53
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 51

def compute_rack_unit
  @compute_rack_unit
end

#descriptionObject

This field is to provide description for the fan module.



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

def description
  @description
end

#equipment_chassisObject

Returns the value of attribute equipment_chassis.



53
54
55
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 53

def equipment_chassis
  @equipment_chassis
end

#equipment_expander_moduleObject

Returns the value of attribute equipment_expander_module.



55
56
57
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 55

def equipment_expander_module
  @equipment_expander_module
end

#equipment_io_cardObject

Returns the value of attribute equipment_io_card.



57
58
59
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 57

def equipment_io_card
  @equipment_io_card
end

#equipment_rack_enclosureObject

Returns the value of attribute equipment_rack_enclosure.



59
60
61
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 59

def equipment_rack_enclosure
  @equipment_rack_enclosure
end

#fansObject

An array of relationships to equipmentFan resources.



62
63
64
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 62

def fans
  @fans
end

#inventory_device_infoObject

Returns the value of attribute inventory_device_info.



64
65
66
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 64

def inventory_device_info
  @inventory_device_info
end

#module_idObject

This field acts as the identifier for this particular Module, within the Fabric Interconnect.



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

def module_id
  @module_id
end

#network_elementObject

Returns the value of attribute network_element.



66
67
68
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 66

def network_element
  @network_element
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/equipment_fan_module.rb', line 23

def object_type
  @object_type
end

#oper_reasonObject

Returns the value of attribute oper_reason.



31
32
33
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 31

def oper_reason
  @oper_reason
end

#oper_stateObject

This field is used to indicate this fan module’s operational state.



34
35
36
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 34

def oper_state
  @oper_state
end

#part_numberObject

This field identifies the Part Number for this Fan Module.



37
38
39
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 37

def part_number
  @part_number
end

#pidObject

This field identifies the Product ID for the fan module.



40
41
42
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 40

def pid
  @pid
end

#registered_deviceObject

Returns the value of attribute registered_device.



68
69
70
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 68

def registered_device
  @registered_device
end

#skuObject

This field identifies the Stockkeeping Unit for this Fan Module.



43
44
45
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 43

def sku
  @sku
end

#tray_idObject

Tray identifier for the fan module.



46
47
48
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 46

def tray_id
  @tray_id
end

#vidObject

This field identifies the Vendor ID for this Fan Module.



49
50
51
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 49

def vid
  @vid
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)



124
125
126
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 124

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)



119
120
121
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 119

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

.attribute_mapObject

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 93

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'description' => :'Description',
    :'module_id' => :'ModuleId',
    :'oper_reason' => :'OperReason',
    :'oper_state' => :'OperState',
    :'part_number' => :'PartNumber',
    :'pid' => :'Pid',
    :'sku' => :'Sku',
    :'tray_id' => :'TrayId',
    :'vid' => :'Vid',
    :'compute_rack_unit' => :'ComputeRackUnit',
    :'equipment_chassis' => :'EquipmentChassis',
    :'equipment_expander_module' => :'EquipmentExpanderModule',
    :'equipment_io_card' => :'EquipmentIoCard',
    :'equipment_rack_enclosure' => :'EquipmentRackEnclosure',
    :'fans' => :'Fans',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'network_element' => :'NetworkElement',
    :'registered_device' => :'RegisteredDevice'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



371
372
373
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 371

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



163
164
165
166
167
168
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 163

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

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



171
172
173
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 171

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



155
156
157
158
159
160
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 155

def self.openapi_nullable
  Set.new([
    :'oper_reason',
    :'fans',
  ])
end

.openapi_typesObject

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 129

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'description' => :'String',
    :'module_id' => :'Integer',
    :'oper_reason' => :'Array<String>',
    :'oper_state' => :'String',
    :'part_number' => :'String',
    :'pid' => :'String',
    :'sku' => :'String',
    :'tray_id' => :'Integer',
    :'vid' => :'String',
    :'compute_rack_unit' => :'ComputeRackUnitRelationship',
    :'equipment_chassis' => :'EquipmentChassisRelationship',
    :'equipment_expander_module' => :'EquipmentExpanderModuleRelationship',
    :'equipment_io_card' => :'EquipmentIoCardRelationship',
    :'equipment_rack_enclosure' => :'EquipmentRackEnclosureRelationship',
    :'fans' => :'Array<EquipmentFanRelationship>',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'network_element' => :'NetworkElementRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      description == o.description &&
      module_id == o.module_id &&
      oper_reason == o.oper_reason &&
      oper_state == o.oper_state &&
      part_number == o.part_number &&
      pid == o.pid &&
      sku == o.sku &&
      tray_id == o.tray_id &&
      vid == o.vid &&
      compute_rack_unit == o.compute_rack_unit &&
      equipment_chassis == o.equipment_chassis &&
      equipment_expander_module == o.equipment_expander_module &&
      equipment_io_card == o.equipment_io_card &&
      equipment_rack_enclosure == o.equipment_rack_enclosure &&
      fans == o.fans &&
      inventory_device_info == o.inventory_device_info &&
      network_element == o.network_element &&
      registered_device == o.registered_device && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 402

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

Parameters:

  • Any valid value

Returns:

  • Returns the value in the form of hash



473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 473

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

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 378

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  EquipmentFanModule.openapi_types.each_pair do |key, type|
    if attributes[EquipmentFanModule.attribute_map[key]].nil? && EquipmentFanModule.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[EquipmentFanModule.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[EquipmentFanModule.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[EquipmentFanModule.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[EquipmentFanModule.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


358
359
360
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 358

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • Hash code



364
365
366
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 364

def hash
  [class_id, object_type, description, module_id, oper_reason, oper_state, part_number, pid, sku, tray_id, vid, compute_rack_unit, equipment_chassis, equipment_expander_module, equipment_io_card, equipment_rack_enclosure, fans, inventory_device_info, network_element, registered_device].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 284

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)

Returns:

  • Returns the object in the form of hash



449
450
451
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 449

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 455

def to_hash
  hash = super
  EquipmentFanModule.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = EquipmentFanModule.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

Returns:

  • String presentation of the object



443
444
445
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 443

def to_s
  to_hash.to_s
end

#valid?Boolean

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

Returns:

  • true if the model is valid



299
300
301
302
303
304
305
306
307
# File 'lib/intersight_client/models/equipment_fan_module.rb', line 299

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