Class: IntersightClient::EquipmentBase

Inherits:
InventoryBase show all
Defined in:
lib/intersight_client/models/equipment_base.rb

Overview

Abstract base class for all equipments which have a vendor /model / serial.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/intersight_client/models/equipment_base.rb', line 123

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

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

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

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

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

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

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

  if attributes.key?(:'previous_fru')
    self.previous_fru = attributes[:'previous_fru']
  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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def class_id
  @class_id
end

#model ⇒ Object

This field identifies the model of the given component.



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

def model
  @model
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def object_type
  @object_type
end

#presence ⇒ Object

This field identifies the presence (equipped) or absence of the given component.



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

def presence
  @presence
end

#previous_fru ⇒ Object

Returns the value of attribute previous_fru.



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

def previous_fru
  @previous_fru
end

#revision ⇒ Object

This field identifies the revision of the given component.



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

def revision
  @revision
end

#serial ⇒ Object

This field identifies the serial of the given component.



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

def serial
  @serial
end

#vendor ⇒ Object

This field identifies the vendor of the given component.



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

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



84
85
86
 
# File 'lib/intersight_client/models/equipment_base.rb', line 84

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)



79
80
81
 
# File 'lib/intersight_client/models/equipment_base.rb', line 79

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.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/intersight_client/models/equipment_base.rb', line 65

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'model' => :'Model',
    :'presence' => :'Presence',
    :'revision' => :'Revision',
    :'serial' => :'Serial',
    :'vendor' => :'Vendor',
    :'previous_fru' => :'PreviousFru'
  }
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



249
250
251
 
# File 'lib/intersight_client/models/equipment_base.rb', line 249

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



109
110
111
112
113
114
 
# File 'lib/intersight_client/models/equipment_base.rb', line 109

def self.openapi_all_of
  [
  :'EquipmentBaseAllOf',
  :'InventoryBase'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



117
118
119
 
# File 'lib/intersight_client/models/equipment_base.rb', line 117

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/intersight_client/models/equipment_base.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/intersight_client/models/equipment_base.rb', line 89

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'model' => :'String',
    :'presence' => :'String',
    :'revision' => :'String',
    :'serial' => :'String',
    :'vendor' => :'String',
    :'previous_fru' => :'EquipmentFruRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/intersight_client/models/equipment_base.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      model == o.model &&
      presence == o.presence &&
      revision == o.revision &&
      serial == o.serial &&
      vendor == o.vendor &&
      previous_fru == o.previous_fru && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/intersight_client/models/equipment_base.rb', line 280

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/intersight_client/models/equipment_base.rb', line 351

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:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/intersight_client/models/equipment_base.rb', line 256

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


236
237
238
 
# File 'lib/intersight_client/models/equipment_base.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



242
243
244
 
# File 'lib/intersight_client/models/equipment_base.rb', line 242

def hash
  [class_id, object_type, model, presence, revision, serial, vendor, previous_fru].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/intersight_client/models/equipment_base.rb', line 174

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



327
328
329
 
# File 'lib/intersight_client/models/equipment_base.rb', line 327

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/intersight_client/models/equipment_base.rb', line 333

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

Returns:

  • (String) —

    String presentation of the object



321
322
323
 
# File 'lib/intersight_client/models/equipment_base.rb', line 321

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



189
190
191
192
193
194
195
196
197
 
# File 'lib/intersight_client/models/equipment_base.rb', line 189

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "bios.Unit", "boot.CddDevice", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "compute.Blade", "compute.Board", "compute.RackUnit", "equipment.Chassis", "equipment.ExpanderModule", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.Fru", "equipment.IoCard", "equipment.IoExpander", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "graphics.Card", "graphics.Controller", "memory.Array", "memory.PersistentMemoryUnit", "memory.Unit", "network.Element", "pci.CoprocessorCard", "pci.Device", "pci.Link", "pci.Switch", "processor.Unit", "security.Unit", "storage.Controller", "storage.DiskSlot", "storage.Enclosure", "storage.EnclosureDisk", "storage.FlexFlashController", "storage.FlexFlashControllerProps", "storage.FlexFlashPhysicalDrive", "storage.FlexFlashVirtualDrive", "storage.FlexUtilPhysicalDrive", "storage.HitachiArray", "storage.HitachiController", "storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.NetAppCluster", "storage.NetAppNode", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PureArray", "storage.PureController", "storage.PureDisk", "storage.SasExpander", "storage.VirtualDrive", "storage.VirtualDriveContainer"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "bios.Unit", "boot.CddDevice", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "compute.Blade", "compute.Board", "compute.RackUnit", "equipment.Chassis", "equipment.ExpanderModule", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.Fru", "equipment.IoCard", "equipment.IoExpander", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "graphics.Card", "graphics.Controller", "memory.Array", "memory.PersistentMemoryUnit", "memory.Unit", "network.Element", "pci.CoprocessorCard", "pci.Device", "pci.Link", "pci.Switch", "processor.Unit", "security.Unit", "storage.Controller", "storage.DiskSlot", "storage.Enclosure", "storage.EnclosureDisk", "storage.FlexFlashController", "storage.FlexFlashControllerProps", "storage.FlexFlashPhysicalDrive", "storage.FlexFlashVirtualDrive", "storage.FlexUtilPhysicalDrive", "storage.HitachiArray", "storage.HitachiController", "storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.NetAppCluster", "storage.NetAppNode", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PureArray", "storage.PureController", "storage.PureDisk", "storage.SasExpander", "storage.VirtualDrive", "storage.VirtualDriveContainer"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end