Class: IntersightClient::HclHardwareCompatibilityProfile

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/hcl_hardware_compatibility_profile.rb

Overview

Profile giving server hardware details, OS details and UCS Version details.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HclHardwareCompatibilityProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



149
150
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/hcl_hardware_compatibility_profile.rb', line 149

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

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

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

  if attributes.key?(:'error_code')
    self.error_code = attributes[:'error_code']
  else
    self.error_code = 'Success'
  end

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

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#driver_iso_url ⇒ Object

Url for the ISO with the drivers supported for the server.



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

def driver_iso_url
  @driver_iso_url
end

#error_code ⇒ Object

Error code indicating the compatibility status. * ‘Success` - The input combination is valid. * `Unknown` - Unknown API request to the service. * `UnknownServer` - An invalid server model is given API requests or the server model is not present in the HCL database. * `InvalidUcsVersion` - UCS Version is not in expected format. * `ProcessorNotSupported` - Processor is not supported with the given Server or the Processor does not exist in the HCL database. * `OSNotSupported` - OS version is not supported with the given server, processor combination or OS information is not present in the HCL database. * `OSUnknown` - OS vendor or version is not known as per the HCL database. * `UCSVersionNotSupported` - UCS Version is not supported with the given server, processor and OS combination or the UCS version is not present in the HCL database. * `UcsVersionServerOSCombinationNotSupported` - Combination of UCS version, server (model and processor) and os version is not supported. * `ProductUnknown` - Product is not known as per the HCL database. * `ProductNotSupported` - Product is not supported in the given UCS version, server (model and processor) and operating system version. * `DriverNameNotSupported` - Driver protocol or name is not supported for the given product. * `FirmwareVersionNotSupported` - Firmware version not supported for the component and the server, operating system combination. * `DriverVersionNotSupported` - Driver version not supported for the component and the server, operating system combination. * `FirmwareVersionDriverVersionCombinationNotSupported` - Both Firmware and Driver versions are not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverVersionNotSupported` - Firmware and Driver version combination not supported for the component and the server, operating system combination. * `FirmwareVersionAndDriverNameNotSupported` - Firmware Version and Driver name or not supported with the component and the server, operating system combination. * `InternalError` - API requests to the service have either failed or timed out. * `MarshallingError` - Error in JSON marshalling. * `Exempted` - An exempted error code means that the product is part of the exempted Catalog and should be ignored for HCL validation purposes.



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

def error_code
  @error_code
end

#id ⇒ Object

Identifier of the hardware compatibility profile.



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

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

def object_type
  @object_type
end

#os_vendor ⇒ Object

Vendor of the Operating System running on the server.



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

def os_vendor
  @os_vendor
end

#os_version ⇒ Object

Version of the Operating System running on the server.



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

def os_version
  @os_version
end

#processor_model ⇒ Object

Model of the processor present in the server.



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

def processor_model
  @processor_model
end

#products ⇒ Object

Returns the value of attribute products.



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

def products
  @products
end

#server_model ⇒ Object

Model of the server as returned by UCSM/CIMC XML API.



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

def server_model
  @server_model
end

#server_revision ⇒ Object

Revision of the server model.



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

def server_revision
  @server_revision
end

#ucs_version ⇒ Object

Version of the UCS software.



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

def ucs_version
  @ucs_version
end

#version_type ⇒ Object

Type of the UCS version indicating whether it is a UCSM release vesion or a IMC release. * ‘UCSM` - The server is managed by UCS Manager. * `IMC` - The server is standalone managed by CIMC.



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

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



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

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)



99
100
101
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 99

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'driver_iso_url' => :'DriverIsoUrl',
    :'error_code' => :'ErrorCode',
    :'id' => :'Id',
    :'os_vendor' => :'OsVendor',
    :'os_version' => :'OsVersion',
    :'processor_model' => :'ProcessorModel',
    :'products' => :'Products',
    :'server_model' => :'ServerModel',
    :'server_revision' => :'ServerRevision',
    :'ucs_version' => :'UcsVersion',
    :'version_type' => :'VersionType'
  }
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



334
335
336
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 334

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



135
136
137
138
139
140
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 135

def self.openapi_all_of
  [
  :'HclHardwareCompatibilityProfileAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



143
144
145
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 143

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
132
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 109

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'driver_iso_url' => :'String',
    :'error_code' => :'String',
    :'id' => :'String',
    :'os_vendor' => :'String',
    :'os_version' => :'String',
    :'processor_model' => :'String',
    :'products' => :'Array<HclProduct>',
    :'server_model' => :'String',
    :'server_revision' => :'String',
    :'ucs_version' => :'String',
    :'version_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 301

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      driver_iso_url == o.driver_iso_url &&
      error_code == o.error_code &&
      id == o.id &&
      os_vendor == o.os_vendor &&
      os_version == o.os_version &&
      processor_model == o.processor_model &&
      products == o.products &&
      server_model == o.server_model &&
      server_revision == o.server_revision &&
      ucs_version == o.ucs_version &&
      version_type == o.version_type && 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



365
366
367
368
369
370
371
372
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
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 365

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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 436

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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 341

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [class_id, object_type, driver_iso_url, error_code, id, os_vendor, os_version, processor_model, products, server_model, server_revision, ucs_version, version_type].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



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



412
413
414
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 418

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



406
407
408
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 406

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



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/intersight_client/models/hcl_hardware_compatibility_profile.rb', line 245

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hcl.HardwareCompatibilityProfile"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hcl.HardwareCompatibilityProfile"])
  return false unless object_type_validator.valid?(@object_type)
  error_code_validator = EnumAttributeValidator.new('String', ["Success", "Unknown", "UnknownServer", "InvalidUcsVersion", "ProcessorNotSupported", "OSNotSupported", "OSUnknown", "UCSVersionNotSupported", "UcsVersionServerOSCombinationNotSupported", "ProductUnknown", "ProductNotSupported", "DriverNameNotSupported", "FirmwareVersionNotSupported", "DriverVersionNotSupported", "FirmwareVersionDriverVersionCombinationNotSupported", "FirmwareVersionAndDriverVersionNotSupported", "FirmwareVersionAndDriverNameNotSupported", "InternalError", "MarshallingError", "Exempted"])
  return false unless error_code_validator.valid?(@error_code)
  version_type_validator = EnumAttributeValidator.new('String', ["UCSM", "IMC"])
  return false unless version_type_validator.valid?(@version_type)
  true && super
end