Class: IntersightClient::FirmwareUpgradeImpactBaseAllOf

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

Overview

Definition of the list of properties defined in ‘firmware.UpgradeImpactBase’, 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 = {}) ⇒ FirmwareUpgradeImpactBaseAllOf

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 106

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

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

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

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

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

def class_id
  @class_id
end

#components ⇒ Object

Returns the value of attribute components.



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

def components
  @components
end

#computation_state ⇒ Object

Captures the status of an upgrade impact calculation. Indicates whether the calculation is complete, in progress or the calculation is impossible due to the absence of the target image on the endpoint. * ‘Inprogress` - Upgrade impact calculation is in progress. * `Completed` - Upgrade impact calculation is completed. * `Unavailable` - Upgrade impact is not available since image is not present in FI.



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

def computation_state
  @computation_state
end

#exclude_components ⇒ Object

Returns the value of attribute exclude_components.



30
31
32
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 30

def exclude_components
  @exclude_components
end

#impacts ⇒ Object

Returns the value of attribute impacts.



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

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

def object_type
  @object_type
end

#summary ⇒ Object

The summary on the component or components getting impacted by the upgrade. * ‘Basic` - Summary of a single instance involved in the upgrade operation. * `Detail` - Summary of the collection of single instances for a complex component involved in the upgrade operation. For example, in case of a server upgrade, a detailed summary indicates impact of all the single instances which are part of the server, such as storage controller, drives, and BIOS.



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

def summary
  @summary
end

Class Method Details

.acceptable_attribute_map ⇒ Object

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



78
79
80
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 60

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'components' => :'Components',
    :'computation_state' => :'ComputationState',
    :'exclude_components' => :'ExcludeComponents',
    :'impacts' => :'Impacts',
    :'summary' => :'Summary'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



258
259
260
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
100
101
102
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 96

def self.openapi_nullable
  Set.new([
    :'components',
    :'exclude_components',
    :'impacts',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 83

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'components' => :'Array<String>',
    :'computation_state' => :'String',
    :'exclude_components' => :'Array<String>',
    :'impacts' => :'Array<FirmwareBaseImpact>',
    :'summary' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      components == o.components &&
      computation_state == o.computation_state &&
      exclude_components == o.exclude_components &&
      impacts == o.impacts &&
      summary == o.summary
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 288

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 359

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 265

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


245
246
247
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



251
252
253
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 251

def hash
  [class_id, object_type, components, computation_state, exclude_components, impacts, summary].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



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 160

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



335
336
337
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 341

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



329
330
331
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 329

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



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/intersight_client/models/firmware_upgrade_impact_base_all_of.rb', line 175

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["firmware.UpgradeImpact", "firmware.UpgradeImpactStatus"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["firmware.UpgradeImpact", "firmware.UpgradeImpactStatus"])
  return false unless object_type_validator.valid?(@object_type)
  computation_state_validator = EnumAttributeValidator.new('String', ["Inprogress", "Completed", "Unavailable"])
  return false unless computation_state_validator.valid?(@computation_state)
  summary_validator = EnumAttributeValidator.new('String', ["Basic", "Detail"])
  return false unless summary_validator.valid?(@summary)
  true
end