Class: IntersightClient::FirmwareUpgradeBase

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

Overview

Firmware upgrade operation that downloads the image from Cisco/appliance/user provided HTTP repository or use the image from a network share and upgrade. The direct download is used for upgrade to use the image from Cisco repository or appliance repository. The network share is used for upgrade to use the image from a network share in user data center.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#direct_download ⇒ Object

Returns the value of attribute direct_download.



25
26
27
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 25

def direct_download
  @direct_download
end

#distributable ⇒ Object

Returns the value of attribute distributable.



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

def distributable
  @distributable
end

#file_server ⇒ Object

Returns the value of attribute file_server.



27
28
29
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 27

def file_server
  @file_server
end

#network_share ⇒ Object

Returns the value of attribute network_share.



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

def network_share
  @network_share
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_upgrade_base.rb', line 23

def object_type
  @object_type
end

#release ⇒ Object

Returns the value of attribute release.



42
43
44
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 42

def release
  @release
end

#skip_estimate_impact ⇒ Object

User has the option to skip the estimate impact calculation.



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

def skip_estimate_impact
  @skip_estimate_impact
end

#status ⇒ Object

Status of the upgrade operation. * NONE - Upgrade status is not populated. * IN_PROGRESS - The upgrade is in progress. * SUCCESSFUL - The upgrade successfully completed. * FAILED - The upgrade shows failed status. * TERMINATED - The upgrade has been terminated.



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

def status
  @status
end

#upgrade_impact ⇒ Object

Returns the value of attribute upgrade_impact.



44
45
46
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 44

def upgrade_impact
  @upgrade_impact
end

#upgrade_status ⇒ Object

Returns the value of attribute upgrade_status.



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

def upgrade_status
  @upgrade_status
end

#upgrade_type ⇒ Object

Desired upgrade mode to choose either direct download based upgrade or network share upgrade. * direct_upgrade - Upgrade mode is direct download. * network_upgrade - Upgrade mode is network upgrade.



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

def upgrade_type
  @upgrade_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)



94
95
96
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 94

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)



89
90
91
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 89

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.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 71

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'direct_download' => :'DirectDownload',
    :'file_server' => :'FileServer',
    :'network_share' => :'NetworkShare',
    :'skip_estimate_impact' => :'SkipEstimateImpact',
    :'status' => :'Status',
    :'upgrade_type' => :'UpgradeType',
    :'distributable' => :'Distributable',
    :'release' => :'Release',
    :'upgrade_impact' => :'UpgradeImpact',
    :'upgrade_status' => :'UpgradeStatus'
  }
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



314
315
316
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 314

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



126
127
128
129
130
131
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 126

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



134
135
136
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 134

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 117

def self.openapi_nullable
  Set.new([
    :'direct_download',
    :'file_server',
    :'network_share',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 99

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'direct_download' => :'FirmwareDirectDownload',
    :'file_server' => :'SoftwarerepositoryFileServer',
    :'network_share' => :'FirmwareNetworkShare',
    :'skip_estimate_impact' => :'Boolean',
    :'status' => :'String',
    :'upgrade_type' => :'String',
    :'distributable' => :'FirmwareDistributableRelationship',
    :'release' => :'SoftwarerepositoryReleaseRelationship',
    :'upgrade_impact' => :'FirmwareUpgradeImpactStatusRelationship',
    :'upgrade_status' => :'FirmwareUpgradeStatusRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      direct_download == o.direct_download &&
      file_server == o.file_server &&
      network_share == o.network_share &&
      skip_estimate_impact == o.skip_estimate_impact &&
      status == o.status &&
      upgrade_type == o.upgrade_type &&
      distributable == o.distributable &&
      release == o.release &&
      upgrade_impact == o.upgrade_impact &&
      upgrade_status == o.upgrade_status && 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



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
379
380
381
382
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 345

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 416

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 321

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


301
302
303
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 307

def hash
  [class_id, object_type, direct_download, file_server, network_share, skip_estimate_impact, status, upgrade_type, distributable, release, upgrade_impact, upgrade_status].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



211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 211

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



392
393
394
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 392

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 398

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



386
387
388
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 386

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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/intersight_client/models/firmware_upgrade_base.rb', line 226

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["firmware.ChassisUpgrade", "firmware.SwitchUpgrade", "firmware.Upgrade"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["firmware.ChassisUpgrade", "firmware.SwitchUpgrade", "firmware.Upgrade"])
  return false unless object_type_validator.valid?(@object_type)
  status_validator = EnumAttributeValidator.new('String', ["NONE", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "TERMINATED"])
  return false unless status_validator.valid?(@status)
  upgrade_type_validator = EnumAttributeValidator.new('String', ["direct_upgrade", "network_upgrade"])
  return false unless upgrade_type_validator.valid?(@upgrade_type)
  true && super
end