Class: IntersightClient::HclExemptedCatalog

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/hcl_exempted_catalog.rb

Overview

Collection used to store exempted products (ie. adapters, storage controllers, etc). These products should be ignored for HCL validation purposes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#commentsObject

Reason for the exemption.



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

def comments
  @comments
end

#nameObject

A unique descriptive name of the exemption.



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

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

def object_type
  @object_type
end

#os_vendorObject

Vendor of the Operating System.



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

def os_vendor
  @os_vendor
end

#os_versionObject

Version of the Operating system.



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

def os_version
  @os_version
end

#processor_nameObject

Name of the processor supported for the server.



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

def processor_name
  @processor_name
end

#product_modelsObject

Returns the value of attribute product_models.



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

def product_models
  @product_models
end

#product_typeObject

Type of the product/adapter say GPU for graphic cards. * “ - Default type of the Product. * Adapter - Represents network adapter cards. * StorageController - Represents storage controllers. * GPU - Represents graphics cards.



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

def product_type
  @product_type
end

#server_pidObject

Three part ID representing the server model as returned by UCSM/CIMC XML APIs.



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

def server_pid
  @server_pid
end

#ucs_versionObject

Version of the UCS software.



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

def ucs_version
  @ucs_version
end

#version_typeObject

Type of the UCS version indicating whether it is a UCSM release vesion or a IMC release.



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

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



100
101
102
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 100

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)



95
96
97
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 95

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

.attribute_mapObject

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 77

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'comments' => :'Comments',
    :'name' => :'Name',
    :'os_vendor' => :'OsVendor',
    :'os_version' => :'OsVersion',
    :'processor_name' => :'ProcessorName',
    :'product_models' => :'ProductModels',
    :'product_type' => :'ProductType',
    :'server_pid' => :'ServerPid',
    :'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



310
311
312
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 310

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



130
131
132
133
134
135
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 130

def self.openapi_all_of
  [
  :'HclExemptedCatalogAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



138
139
140
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 138

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



123
124
125
126
127
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 123

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

.openapi_typesObject

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 105

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'comments' => :'String',
    :'name' => :'String',
    :'os_vendor' => :'String',
    :'os_version' => :'String',
    :'processor_name' => :'String',
    :'product_models' => :'Array<String>',
    :'product_type' => :'String',
    :'server_pid' => :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      comments == o.comments &&
      name == o.name &&
      os_vendor == o.os_vendor &&
      os_version == o.os_version &&
      processor_name == o.processor_name &&
      product_models == o.product_models &&
      product_type == o.product_type &&
      server_pid == o.server_pid &&
      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



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

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



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

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 297

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



303
304
305
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 303

def hash
  [class_id, object_type, comments, name, os_vendor, os_version, processor_name, product_models, product_type, server_pid, ucs_version, version_type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 219

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:

  • (Hash)

    Returns the object in the form of hash



388
389
390
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 388

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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

    String presentation of the object



382
383
384
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 382

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



234
235
236
237
238
239
240
241
242
243
244
# File 'lib/intersight_client/models/hcl_exempted_catalog.rb', line 234

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hcl.ExemptedCatalog"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hcl.ExemptedCatalog"])
  return false unless object_type_validator.valid?(@object_type)
  product_type_validator = EnumAttributeValidator.new('String', ["", "Adapter", "StorageController", "GPU"])
  return false unless product_type_validator.valid?(@product_type)
  true && super
end