Class: IntersightClient::EquipmentFan

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

Overview

Fan in a Fabric Interconnect / Chassis / RackUnit.

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 = {}) ⇒ EquipmentFan

Initializes the object



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
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
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 165

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

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

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

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

  if attributes.key?(:'fan_module_id')
    self.fan_module_id = attributes[:'fan_module_id']
  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?(:'equipment_fan_module')
    self.equipment_fan_module = attributes[:'equipment_fan_module']
  end

  if attributes.key?(:'equipment_fex')
    self.equipment_fex = attributes[:'equipment_fex']
  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_id ⇒ Object

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.rb', line 20

def class_id
  @class_id
end

#description ⇒ Object

This field is to provide description for the fan.



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

def description
  @description
end

#equipment_fan_module ⇒ Object

Returns the value of attribute equipment_fan_module.



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

def equipment_fan_module
  @equipment_fan_module
end

#equipment_fex ⇒ Object

Returns the value of attribute equipment_fex.



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

def equipment_fex
  @equipment_fex
end

#fan_id ⇒ Object

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



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

def fan_id
  @fan_id
end

#fan_module_id ⇒ Object

This field is used to identify the Fan Module to which this Fan belongs.



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

def fan_module_id
  @fan_module_id
end

#inventory_device_info ⇒ Object

Returns the value of attribute inventory_device_info.



61
62
63
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 61

def inventory_device_info
  @inventory_device_info
end

#module_id ⇒ Object

Fan module Identifier for the fan.



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

def module_id
  @module_id
end

#object_type ⇒ Object

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.rb', line 23

def object_type
  @object_type
end

#oper_reason ⇒ Object

Returns the value of attribute oper_reason.



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

def oper_reason
  @oper_reason
end

#oper_state ⇒ Object

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



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

def oper_state
  @oper_state
end

#part_number ⇒ Object

This field identifies the Part Number for this Fan Unit.



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

def part_number
  @part_number
end

#pid ⇒ Object

This field identifies the Product ID for the fans.



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

def pid
  @pid
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



63
64
65
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 63

def registered_device
  @registered_device
end

#sku ⇒ Object

This field identifies the Stockkeeping Unit for this Fan Unit.



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

def sku
  @sku
end

#tray_id ⇒ Object

Tray identifier for the fan module.



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

def tray_id
  @tray_id
end

#vid ⇒ Object

This field identifies the Vendor ID for this Fan Unit.



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

def vid
  @vid
end

Class Method Details

.acceptable_attribute_map ⇒ Object

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



116
117
118
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 116

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

.acceptable_attributes ⇒ Object

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



111
112
113
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 111

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

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 88

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'description' => :'Description',
    :'fan_id' => :'FanId',
    :'fan_module_id' => :'FanModuleId',
    :'module_id' => :'ModuleId',
    :'oper_reason' => :'OperReason',
    :'oper_state' => :'OperState',
    :'part_number' => :'PartNumber',
    :'pid' => :'Pid',
    :'sku' => :'Sku',
    :'tray_id' => :'TrayId',
    :'vid' => :'Vid',
    :'equipment_fan_module' => :'EquipmentFanModule',
    :'equipment_fex' => :'EquipmentFex',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'registered_device' => :'RegisteredDevice'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



342
343
344
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 342

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



151
152
153
154
155
156
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 151

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



159
160
161
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 159

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
148
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 144

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

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 121

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'description' => :'String',
    :'fan_id' => :'Integer',
    :'fan_module_id' => :'Integer',
    :'module_id' => :'Integer',
    :'oper_reason' => :'Array<String>',
    :'oper_state' => :'String',
    :'part_number' => :'String',
    :'pid' => :'String',
    :'sku' => :'String',
    :'tray_id' => :'Integer',
    :'vid' => :'String',
    :'equipment_fan_module' => :'EquipmentFanModuleRelationship',
    :'equipment_fex' => :'EquipmentFexRelationship',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 305

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 &&
      fan_id == o.fan_id &&
      fan_module_id == o.fan_module_id &&
      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 &&
      equipment_fan_module == o.equipment_fan_module &&
      equipment_fex == o.equipment_fex &&
      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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 373

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 444

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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 349

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


329
330
331
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



335
336
337
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 335

def hash
  [class_id, object_type, description, fan_id, fan_module_id, module_id, oper_reason, oper_state, part_number, pid, sku, tray_id, vid, equipment_fan_module, equipment_fex, inventory_device_info, registered_device].hash
end

#list_invalid_properties ⇒ Object

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



258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 258

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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



420
421
422
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 420

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 426

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

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

#to_s ⇒ String

Returns the string representation of the object



414
415
416
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 414

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



273
274
275
276
277
278
279
280
281
 
# File 'lib/intersight_client/models/equipment_fan.rb', line 273

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