Class: IntersightClient::FirmwareBaseDistributable

Inherits:
SoftwarerepositoryFile show all
Defined in:
lib/intersight_client/models/firmware_base_distributable.rb

Overview

An image distributed by Cisco.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from SoftwarerepositoryFile

#description, #download_count, #import_action, #import_state, #imported_time, #last_access_time, #md5e_tag, #md5sum, #name, #release_date, #sha512sum, #size, #software_advisory_url, #source, #version

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bundle_type ⇒ Object

The bundle type of the image, as published on cisco.com.



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

def bundle_type
  @bundle_type
end

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

def class_id
  @class_id
end

#component_meta ⇒ Object

Returns the value of attribute component_meta.



28
29
30
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 28

def component_meta
  @component_meta
end

#distributable_metas ⇒ Object

An array of relationships to firmwareDistributableMeta resources.



60
61
62
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 60

def distributable_metas
  @distributable_metas
end

#guid ⇒ Object

The unique identifier for an image in a Cisco repository.



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

def guid
  @guid
end

#image_type ⇒ Object

The type of image which the distributable falls into according to the component it can upgrade. For e.g.; Standalone server, Intersight managed server, UCS Managed Fabric Interconnect. The field is used in private appliance mode, where image does not have description populated from CCO.



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

def image_type
  @image_type
end

#mdfid ⇒ Object

The mdfid of the image provided by cisco.com.



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

def mdfid
  @mdfid
end

#model ⇒ Object

The endpoint model for which this firmware image is applicable.



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

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

def object_type
  @object_type
end

#platform_type ⇒ Object

The platform type of the image.



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

def platform_type
  @platform_type
end

#recommended_build ⇒ Object

The build which is recommended by Cisco.



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

def recommended_build
  @recommended_build
end

#release ⇒ Object

Returns the value of attribute release.



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

def release
  @release
end

#release_notes_url ⇒ Object

The url for the release notes of this image.



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

def release_notes_url
  @release_notes_url
end

#software_type_id ⇒ Object

The software type id provided by cisco.com.



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

def software_type_id
  @software_type_id
end

#supported_models ⇒ Object

Returns the value of attribute supported_models.



54
55
56
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 54

def supported_models
  @supported_models
end

#vendor ⇒ Object

The vendor or publisher of this file.



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

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)



114
115
116
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 114

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)



109
110
111
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 109

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'bundle_type' => :'BundleType',
    :'component_meta' => :'ComponentMeta',
    :'guid' => :'Guid',
    :'image_type' => :'ImageType',
    :'mdfid' => :'Mdfid',
    :'model' => :'Model',
    :'platform_type' => :'PlatformType',
    :'recommended_build' => :'RecommendedBuild',
    :'release_notes_url' => :'ReleaseNotesUrl',
    :'software_type_id' => :'SoftwareTypeId',
    :'supported_models' => :'SupportedModels',
    :'vendor' => :'Vendor',
    :'distributable_metas' => :'DistributableMetas',
    :'release' => :'Release'
  }
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



353
354
355
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 353

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'FirmwareBaseDistributableAllOf',
  :'SoftwarerepositoryFile'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



158
159
160
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 158

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
145
146
147
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 141

def self.openapi_nullable
  Set.new([
    :'component_meta',
    :'supported_models',
    :'distributable_metas',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'bundle_type' => :'String',
    :'component_meta' => :'Array<FirmwareComponentMeta>',
    :'guid' => :'String',
    :'image_type' => :'String',
    :'mdfid' => :'String',
    :'model' => :'String',
    :'platform_type' => :'String',
    :'recommended_build' => :'String',
    :'release_notes_url' => :'String',
    :'software_type_id' => :'String',
    :'supported_models' => :'Array<String>',
    :'vendor' => :'String',
    :'distributable_metas' => :'Array<FirmwareDistributableMetaRelationship>',
    :'release' => :'SoftwarerepositoryReleaseRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      bundle_type == o.bundle_type &&
      component_meta == o.component_meta &&
      guid == o.guid &&
      image_type == o.image_type &&
      mdfid == o.mdfid &&
      model == o.model &&
      platform_type == o.platform_type &&
      recommended_build == o.recommended_build &&
      release_notes_url == o.release_notes_url &&
      software_type_id == o.software_type_id &&
      supported_models == o.supported_models &&
      vendor == o.vendor &&
      distributable_metas == o.distributable_metas &&
      release == o.release && 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



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
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 384

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



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

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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 360

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


340
341
342
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



346
347
348
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 346

def hash
  [class_id, object_type, bundle_type, component_meta, guid, image_type, mdfid, model, platform_type, recommended_build, release_notes_url, software_type_id, supported_models, vendor, distributable_metas, release].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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 255

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

  if !@supported_models.nil? && @supported_models.length < 1
    invalid_properties.push('invalid value for "supported_models", number of items must be greater than or equal to 1.')
  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



431
432
433
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 431

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



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

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



425
426
427
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 425

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



274
275
276
277
278
279
280
281
282
283
 
# File 'lib/intersight_client/models/firmware_base_distributable.rb', line 274

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["firmware.Distributable", "firmware.DriverDistributable", "firmware.ServerConfigurationUtilityDistributable", "software.ApplianceDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["firmware.Distributable", "firmware.DriverDistributable", "firmware.ServerConfigurationUtilityDistributable", "software.ApplianceDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@supported_models.nil? && @supported_models.length < 1
  true && super
end