Class: IntersightClient::FirmwareUpgradeStatus

Inherits:
ConnectorDownloadStatus show all
Defined in:
lib/intersight_client/models/firmware_upgrade_status.rb

Overview

The status for the upgrade operation to include the status for the download and upgrade stages.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ConnectorDownloadStatus

#checksum, #download_error, #download_progress, #download_retries, #sha256checksum

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
216
217
218
219
220
221
222
223
224
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 147

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

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

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

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

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

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#download_message ⇒ Object

The message from the endpoint during the download.



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

def download_message
  @download_message
end

#download_percentage ⇒ Object

The percentage of the image downloaded in the endpoint.



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

def download_percentage
  @download_percentage
end

#download_stage ⇒ Object

The image download stages. Example:downloading, flashing.



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

def download_stage
  @download_stage
end

#ep_power_status ⇒ Object

The server power status after the upgrade request is submitted in the endpoint. * none - Server power status is none. * ‘powered on` - Server power status is powered on. * `powered off` - Server power status is powered off.



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

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

def object_type
  @object_type
end

#overall_error ⇒ Object

The reason for the operation failure.



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

def overall_error
  @overall_error
end

#overall_percentage ⇒ Object

The overall percentage of the operation.



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

def overall_percentage
  @overall_percentage
end

#overallstatus ⇒ Object

The overall status of the operation. * none - Upgrade stage is no upgrade stage. * started - Upgrade stage is started. * ‘prepare initiating` - Upgrade configuration is being prepared. * `prepare initiated` - Upgrade configuration is initiated. * prepared - Upgrade configuration is prepared. * `download initiating` - Upgrade stage is download initiating. * `download initiated` - Upgrade stage is download initiated. * downloading - Upgrade stage is downloading. * downloaded - Upgrade stage is downloaded. * `upgrade initiating on fabric A` - Upgrade stage is in upgrade initiating when upgrade is being started in endopint. * `upgrade initiated on fabric A` - Upgrade stage is in upgrade initiated when the upgrade has started in endpoint. * `upgrading fabric A` - Upgrade stage is in upgrading when the upgrade requires reboot to complete. * `rebooting fabric A` - Upgrade is in rebooting when the endpoint is being rebooted. * `upgraded fabric A` - Upgrade stage is in upgraded when the corresponding endpoint has completed. * `upgrade initiating on fabric B` - Upgrade stage is in upgrade initiating when upgrade is being started in endopint. * `upgrade initiated on fabric B` - Upgrade stage is in upgrade initiated when upgrade has started in endpoint. * `upgrading fabric B` - Upgrade stage is in upgrading when the upgrade requires reboot to complete. * `rebooting fabric B` - Upgrade is in rebooting when the endpoint is being rebooted. * `upgraded fabric B` - Upgrade stage is in upgraded when the corresponding endpoint has completed. * `upgrade initiating` - Upgrade stage is upgrade initiating. * `upgrade initiated` - Upgrade stage is upgrade initiated. * upgrading - Upgrade stage is upgrading. * `oob images staging` - Out-of-band component images staging. * `oob images staged` - Out-of-band component images staged. * rebooting - Upgrade is rebooting the endpoint. * upgraded - Upgrade stage is upgraded. * success - Upgrade stage is success. * failed - Upgrade stage is upgrade failed. * terminated - Upgrade stage is terminated. * pending - Upgrade stage is pending. * ReadyForCache - The image is ready to be cached into the Intersight Appliance. * Caching - The image will be cached into Intersight Appliance or an endpoint cache. * Cached - The image has been cached into the Intersight Appliance or endpoint cache. * CachingFailed - The image caching into the Intersight Appliance failed or endpoint cache.



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

def overallstatus
  @overallstatus
end

#pending_type ⇒ Object

Pending reason for the upgrade waiting. * none - Upgrade pending reason is none. * ‘pending for next reboot` - Upgrade pending reason is pending for next reboot.



47
48
49
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 47

def pending_type
  @pending_type
end

#sd_card_download_error ⇒ Object

The error message from the endpoint during the SD card download.



50
51
52
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 50

def sd_card_download_error
  @sd_card_download_error
end

#upgrade ⇒ Object

Returns the value of attribute upgrade.



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

def upgrade
  @upgrade
end

#workflow ⇒ Object

Returns the value of attribute workflow.



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

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



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

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)



98
99
100
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 98

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'download_message' => :'DownloadMessage',
    :'download_percentage' => :'DownloadPercentage',
    :'download_stage' => :'DownloadStage',
    :'ep_power_status' => :'EpPowerStatus',
    :'overall_error' => :'OverallError',
    :'overall_percentage' => :'OverallPercentage',
    :'overallstatus' => :'Overallstatus',
    :'pending_type' => :'PendingType',
    :'sd_card_download_error' => :'SdCardDownloadError',
    :'upgrade' => :'Upgrade',
    :'workflow' => :'Workflow'
  }
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



344
345
346
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 344

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



133
134
135
136
137
138
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 133

def self.openapi_all_of
  [
  :'ConnectorDownloadStatus',
  :'FirmwareUpgradeStatusAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



141
142
143
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 141

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'download_message' => :'String',
    :'download_percentage' => :'Integer',
    :'download_stage' => :'String',
    :'ep_power_status' => :'String',
    :'overall_error' => :'String',
    :'overall_percentage' => :'Integer',
    :'overallstatus' => :'String',
    :'pending_type' => :'String',
    :'sd_card_download_error' => :'String',
    :'upgrade' => :'FirmwareUpgradeBaseRelationship',
    :'workflow' => :'WorkflowWorkflowInfoRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      download_message == o.download_message &&
      download_percentage == o.download_percentage &&
      download_stage == o.download_stage &&
      ep_power_status == o.ep_power_status &&
      overall_error == o.overall_error &&
      overall_percentage == o.overall_percentage &&
      overallstatus == o.overallstatus &&
      pending_type == o.pending_type &&
      sd_card_download_error == o.sd_card_download_error &&
      upgrade == o.upgrade &&
      workflow == o.workflow && 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



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
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 375

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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 446

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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 351

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


331
332
333
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 331

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



337
338
339
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 337

def hash
  [class_id, object_type, download_message, download_percentage, download_stage, ep_power_status, overall_error, overall_percentage, overallstatus, pending_type, sd_card_download_error, upgrade, workflow].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



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

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



422
423
424
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 422

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 428

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



416
417
418
 
# File 'lib/intersight_client/models/firmware_upgrade_status.rb', line 416

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["firmware.UpgradeStatus"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["firmware.UpgradeStatus"])
  return false unless object_type_validator.valid?(@object_type)
  ep_power_status_validator = EnumAttributeValidator.new('String', ["none", "powered on", "powered off"])
  return false unless ep_power_status_validator.valid?(@ep_power_status)
  overallstatus_validator = EnumAttributeValidator.new('String', ["none", "started", "prepare initiating", "prepare initiated", "prepared", "download initiating", "download initiated", "downloading", "downloaded", "upgrade initiating on fabric A", "upgrade initiated on fabric A", "upgrading fabric A", "rebooting fabric A", "upgraded fabric A", "upgrade initiating on fabric B", "upgrade initiated on fabric B", "upgrading fabric B", "rebooting fabric B", "upgraded fabric B", "upgrade initiating", "upgrade initiated", "upgrading", "oob images staging", "oob images staged", "rebooting", "upgraded", "success", "failed", "terminated", "pending", "ReadyForCache", "Caching", "Cached", "CachingFailed"])
  return false unless overallstatus_validator.valid?(@overallstatus)
  pending_type_validator = EnumAttributeValidator.new('String', ["none", "pending for next reboot"])
  return false unless pending_type_validator.valid?(@pending_type)
  true && super
end