Class: IntersightClient::FirmwareBaseImpactAllOf

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

Overview

Definition of the list of properties defined in ‘firmware.BaseImpact’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FirmwareBaseImpactAllOf

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
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
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 126

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

  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?(:'computation_error')
    self.computation_error = attributes[:'computation_error']
  end

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

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

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

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

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

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

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

  if attributes.key?(:'version_impact')
    self.version_impact = attributes[:'version_impact']
  else
    self.version_impact = 'None'
  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_base_impact_all_of.rb', line 20

def class_id
  @class_id
end

#computation_error ⇒ Object

Details for the error that occurred during the reboot validation analysis.



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

def computation_error
  @computation_error
end

#computation_status_detail ⇒ Object

The computation status of the estimate operation for a component. * ‘Inprogress` - Upgrade impact calculation is in progress. * `Completed` - Upgrade impact calculation is completed. * `Unavailable` - Upgrade impact is not available since the image is not present in the Fabric Interconnect. * `Failed` - Upgrade impact is not available due to an unknown error.



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

def computation_status_detail
  @computation_status_detail
end

#domain_name ⇒ Object

The endpoint type or name.



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

def domain_name
  @domain_name
end

#end_point ⇒ Object

A reference to a REST resource, uniquely identified by object type and MOID.



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

def end_point
  @end_point
end

#firmware_version ⇒ Object

The current firmware version of the component.



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

def firmware_version
  @firmware_version
end

#impact_type ⇒ Object

The impact type of the endpoint, whether a reboot is required or not. * ‘NoReboot` - A reboot is not required for the endpoint after upgrade. * `Reboot` - A reboot is required to the endpoint after upgrade.



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

def impact_type
  @impact_type
end

#model ⇒ Object

The model details of the component.



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

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

def object_type
  @object_type
end

#target_firmware_version ⇒ Object

The target firmware version of the component.



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

def target_firmware_version
  @target_firmware_version
end

#version_impact ⇒ Object

The change of version impact for the endpoint. * ‘None` - No change in version for the component. * `Upgrade` - The component will be upgraded. * `Downgrade` - The component will be downgraded.



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

def version_impact
  @version_impact
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



97
98
99
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 97

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 75

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'computation_error' => :'ComputationError',
    :'computation_status_detail' => :'ComputationStatusDetail',
    :'domain_name' => :'DomainName',
    :'end_point' => :'EndPoint',
    :'firmware_version' => :'FirmwareVersion',
    :'impact_type' => :'ImpactType',
    :'model' => :'Model',
    :'target_firmware_version' => :'TargetFirmwareVersion',
    :'version_impact' => :'VersionImpact'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



306
307
308
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 306

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 102

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'computation_error' => :'String',
    :'computation_status_detail' => :'String',
    :'domain_name' => :'String',
    :'end_point' => :'String',
    :'firmware_version' => :'String',
    :'impact_type' => :'String',
    :'model' => :'String',
    :'target_firmware_version' => :'String',
    :'version_impact' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      computation_error == o.computation_error &&
      computation_status_detail == o.computation_status_detail &&
      domain_name == o.domain_name &&
      end_point == o.end_point &&
      firmware_version == o.firmware_version &&
      impact_type == o.impact_type &&
      model == o.model &&
      target_firmware_version == o.target_firmware_version &&
      version_impact == o.version_impact
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



336
337
338
339
340
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
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 336

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 407

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 313

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


293
294
295
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



299
300
301
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 299

def hash
  [class_id, object_type, computation_error, computation_status_detail, domain_name, end_point, firmware_version, impact_type, model, target_firmware_version, version_impact].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



192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 192

def list_invalid_properties
  invalid_properties = Array.new
  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:

  • Returns the object in the form of hash



383
384
385
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 383

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 389

def to_hash
  hash = {}
  FirmwareBaseImpactAllOf.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = FirmwareBaseImpactAllOf.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 presentation of the object



377
378
379
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 377

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/intersight_client/models/firmware_base_impact_all_of.rb', line 207

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["firmware.ChassisUpgradeImpact", "firmware.ComponentImpact", "firmware.FabricUpgradeImpact", "firmware.ServerUpgradeImpact"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["firmware.ChassisUpgradeImpact", "firmware.ComponentImpact", "firmware.FabricUpgradeImpact", "firmware.ServerUpgradeImpact"])
  return false unless object_type_validator.valid?(@object_type)
  computation_status_detail_validator = EnumAttributeValidator.new('String', ["Inprogress", "Completed", "Unavailable", "Failed"])
  return false unless computation_status_detail_validator.valid?(@computation_status_detail)
  impact_type_validator = EnumAttributeValidator.new('String', ["NoReboot", "Reboot"])
  return false unless impact_type_validator.valid?(@impact_type)
  version_impact_validator = EnumAttributeValidator.new('String', ["None", "Upgrade", "Downgrade"])
  return false unless version_impact_validator.valid?(@version_impact)
  true
end