Class: IntersightClient::FirmwareDirectDownload

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/firmware_direct_download.rb

Overview

A specification for downloading the image from Cisco or appliance repository or user provided HTTP file server that hosts the image for firmware upgrade.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FirmwareDirectDownload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'image_source')
    self.image_source = attributes[:'image_source']
  else
    self.image_source = 'cisco'
  end

  if attributes.key?(:'is_password_set')
    self.is_password_set = attributes[:'is_password_set']
  else
    self.is_password_set = false
  end

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

  if attributes.key?(:'upgradeoption')
    self.upgradeoption = attributes[:'upgradeoption']
  else
    self.upgradeoption = 'sd_upgrade_mount_only'
  end

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

def class_id
  @class_id
end

#http_server ⇒ Object

Returns the value of attribute http_server.



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

def http_server
  @http_server
end

#image_source ⇒ Object

Source type referring the image to be downloaded from CCO or from a local HTTPS server. * ‘cisco` - Image to be downloaded from Cisco software repository. * `localHttp` - Image to be downloaded from a https server.



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

def image_source
  @image_source
end

#is_password_set ⇒ Object

Indicates whether the value of the ‘password’ property has been set.



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

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

def object_type
  @object_type
end

#password ⇒ Object

Password as configured on the local https server.



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

def password
  @password
end

#upgradeoption ⇒ Object

Option to control the upgrade, e.g., sd_upgrade_mount_only - download the image into sd and upgrade wait for the server on-next boot. * ‘sd_upgrade_mount_only` - Direct upgrade SD upgrade mount only. * `sd_download_only` - Direct upgrade SD download only. * `sd_upgrade_only` - Direct upgrade SD upgrade only. * `sd_upgrade_full` - Direct upgrade SD upgrade full. * `download_only` - Direct upgrade image download only. * `upgrade_full` - The upgrade downloads or mounts the image, and reboots immediately for an upgrade. * `upgrade_mount_only` - The upgrade downloads or mounts the image. The upgrade happens in next reboot. * `chassis_upgrade_full` - Direct upgrade chassis upgrade full.



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

def upgradeoption
  @upgradeoption
end

#username ⇒ Object

Username as configured on the local https server.



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

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



84
85
86
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 84

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)



79
80
81
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 79

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.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 65

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'http_server' => :'HttpServer',
    :'image_source' => :'ImageSource',
    :'is_password_set' => :'IsPasswordSet',
    :'password' => :'Password',
    :'upgradeoption' => :'Upgradeoption',
    :'username' => :'Username'
  }
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



284
285
286
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 284

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



110
111
112
113
114
115
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 110

def self.openapi_all_of
  [
  :'FirmwareDirectDownloadAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



118
119
120
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 118

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 103

def self.openapi_nullable
  Set.new([
    :'http_server',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 89

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'http_server' => :'FirmwareHttpServer',
    :'image_source' => :'String',
    :'is_password_set' => :'Boolean',
    :'password' => :'String',
    :'upgradeoption' => :'String',
    :'username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      http_server == o.http_server &&
      image_source == o.image_source &&
      is_password_set == o.is_password_set &&
      password == o.password &&
      upgradeoption == o.upgradeoption &&
      username == o.username && 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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 315

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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 386

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 291

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 277

def hash
  [class_id, object_type, http_server, image_source, is_password_set, password, upgradeoption, username].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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 185

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



362
363
364
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 368

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



356
357
358
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 356

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



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/intersight_client/models/firmware_direct_download.rb', line 200

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["firmware.DirectDownload"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["firmware.DirectDownload"])
  return false unless object_type_validator.valid?(@object_type)
  image_source_validator = EnumAttributeValidator.new('String', ["cisco", "localHttp"])
  return false unless image_source_validator.valid?(@image_source)
  upgradeoption_validator = EnumAttributeValidator.new('String', ["sd_upgrade_mount_only", "sd_download_only", "sd_upgrade_only", "sd_upgrade_full", "download_only", "upgrade_full", "upgrade_mount_only", "chassis_upgrade_full"])
  return false unless upgradeoption_validator.valid?(@upgradeoption)
  true && super
end