Class: IntersightClient::SoftwarerepositoryFile

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

Overview

A file that resides either in an external repository or has been imported to the local repository. If the file is available in the local repository, it is marked as cached. If not, it represents a pointer to a file in an external repository. Instances of this MO will be implicitly created as part of the file import operation.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 169

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

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

  if attributes.key?(:'import_action')
    self.import_action = attributes[:'import_action']
  else
    self.import_action = 'None'
  end

  if attributes.key?(:'import_state')
    self.import_state = attributes[:'import_state']
  else
    self.import_state = 'ReadyForImport'
  end

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

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

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

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#description ⇒ Object

User provided description about the file. Cisco provided description for image inventoried from a Cisco repository.



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

def description
  @description
end

#download_count ⇒ Object

The number of times this file has been downloaded from the local repository. It is used by the repository monitoring process to determine the files that are to be evicted from the cache.



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

def download_count
  @download_count
end

#import_action ⇒ Object

The action to be performed on the imported file. If ‘PreCache’ is set, the image will be cached in Appliance. Applicable in Intersight appliance deployment. If ‘Evict’ is set, the cached file will be removed. Applicable in Intersight appliance deployment. If ‘GeneratePreSignedUploadUrl’ is set, generates pre signed URL (s) for the file to be imported into the repository. Applicable for local machine source. The URL (s) will be populated under LocalMachine file server. If ‘CompleteImportProcess’ is set, the ImportState is marked as ‘Imported’. Applicable for local machine source. If ‘Cancel’ is set, the ImportState is marked as ‘Failed’. Applicable for local machine source. * ‘None` - No action should be taken on the imported file. * `GeneratePreSignedUploadUrl` - Generate pre signed URL of file for importing into the repository. * `GeneratePreSignedDownloadUrl` - Generate pre signed URL of file in the repository to download. * `CompleteImportProcess` - Mark that the import process of the file into the repository is complete. * `MarkImportFailed` - Mark to indicate that the import process of the file into the repository failed. * `PreCache` - Cache the file into the Intersight Appliance. * `Cancel` - The cancel import process for the file into the repository. * `Extract` - The action to extract the file in the external repository. * `Evict` - Evict the cached file from the Intersight Appliance.



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

def import_action
  @import_action
end

#import_state ⇒ Object

The state of this file in the repository or Appliance. The importState is updated during the import operation and as part of the repository monitoring process. * ‘ReadyForImport` - The image is ready to be imported into the repository. * `Importing` - The image is being imported into the repository. * `Imported` - The image has been extracted and imported into the repository. * `PendingExtraction` - Indicates that the image has been imported but not extracted in the repository. * `Extracting` - Indicates that the image is being extracted into the repository. * `Extracted` - Indicates that the image has been extracted into the repository. * `Failed` - The image import from an external source to the repository has failed. * `MetaOnly` - The image is present in an external repository. * `ReadyForCache` - The image is ready to be cached into the Intersight Appliance. * `Caching` - Indicates that the image is being cached into the Intersight Appliance or endpoint cache. * `Cached` - Indicates that the image has been cached into the Intersight Appliance or endpoint cache. * `CachingFailed` - Indicates that the image caching into the Intersight Appliance failed or endpoint cache. * `Corrupted` - Indicates that the image in the local repository (or endpoint cache) has been corrupted after it was cached. * `Evicted` - Indicates that the image has been evicted from the Intersight Appliance (or endpoint cache) to reclaim storage space. * `Invalid` - Indicates that the corresponding distributable MO has been removed from the backend. This can be due to unpublishing of an image.



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

def import_state
  @import_state
end

#imported_time ⇒ Object

The time at which this image or file was imported/cached into the repositry. if the ‘ImportState’ is ‘Imported’, the time at which this image or file was imported. if the ‘ImportState’ is ‘Cached’, the time at which this image or file was cached.



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

def imported_time
  @imported_time
end

#last_access_time ⇒ Object

The time at which this file was last downloaded from the local repository. It is used by the repository monitoring process to determine the files that are to be evicted from the cache.



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

def last_access_time
  @last_access_time
end

#md5e_tag ⇒ Object

The MD5 ETag for a file that is stored in Intersight repository or in the appliance cache. Warning - MD5 is currently broken and this will be migrated to SHA shortly.



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

def md5e_tag
  @md5e_tag
end

#md5sum ⇒ Object

The md5sum checksum of the file. This information is available for all Cisco distributed images and files imported to the local repository.



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

def md5sum
  @md5sum
end

#name ⇒ Object

The name of the file. It is populated as part of the image import operation.



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

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

def object_type
  @object_type
end

#release_date ⇒ Object

The date on which the file was released or distributed by its vendor.



53
54
55
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 53

def release_date
  @release_date
end

#sha512sum ⇒ Object

The sha512sum of the file. This information is available for all Cisco distributed images and files imported to the local repository.



56
57
58
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 56

def sha512sum
  @sha512sum
end

#size ⇒ Object

The size (in bytes) of the file. This information is available for all Cisco distributed images and files imported to the local repository.



59
60
61
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 59

def size
  @size
end

#software_advisory_url ⇒ Object

The software advisory, if any, provided by the vendor for this file.



62
63
64
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 62

def software_advisory_url
  @software_advisory_url
end

#source ⇒ Object

Returns the value of attribute source.



64
65
66
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 64

def source
  @source
end

#version ⇒ Object

Vendor provided version for the file.



67
68
69
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 67

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



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

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)



115
116
117
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 115

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.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 92

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'description' => :'Description',
    :'download_count' => :'DownloadCount',
    :'import_action' => :'ImportAction',
    :'import_state' => :'ImportState',
    :'imported_time' => :'ImportedTime',
    :'last_access_time' => :'LastAccessTime',
    :'md5e_tag' => :'Md5eTag',
    :'md5sum' => :'Md5sum',
    :'name' => :'Name',
    :'release_date' => :'ReleaseDate',
    :'sha512sum' => :'Sha512sum',
    :'size' => :'Size',
    :'software_advisory_url' => :'SoftwareAdvisoryUrl',
    :'source' => :'Source',
    :'version' => :'Version'
  }
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



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

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



155
156
157
158
159
160
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 155

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



163
164
165
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 163

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



148
149
150
151
152
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 148

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

.openapi_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 125

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'description' => :'String',
    :'download_count' => :'Integer',
    :'import_action' => :'String',
    :'import_state' => :'String',
    :'imported_time' => :'Time',
    :'last_access_time' => :'Time',
    :'md5e_tag' => :'String',
    :'md5sum' => :'String',
    :'name' => :'String',
    :'release_date' => :'Time',
    :'sha512sum' => :'String',
    :'size' => :'Integer',
    :'software_advisory_url' => :'String',
    :'source' => :'SoftwarerepositoryFileServer',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 346

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      description == o.description &&
      download_count == o.download_count &&
      import_action == o.import_action &&
      import_state == o.import_state &&
      imported_time == o.imported_time &&
      last_access_time == o.last_access_time &&
      md5e_tag == o.md5e_tag &&
      md5sum == o.md5sum &&
      name == o.name &&
      release_date == o.release_date &&
      sha512sum == o.sha512sum &&
      size == o.size &&
      software_advisory_url == o.software_advisory_url &&
      source == o.source &&
      version == o.version && 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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 414

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



485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 485

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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 390

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


370
371
372
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 370

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



376
377
378
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 376

def hash
  [class_id, object_type, description, download_count, import_action, import_state, imported_time, last_access_time, md5e_tag, md5sum, name, release_date, sha512sum, size, software_advisory_url, source, version].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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 260

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

  if !@name.nil? && @name.to_s.length > 128
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
  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



461
462
463
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 461

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



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 467

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



455
456
457
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 455

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/intersight_client/models/softwarerepository_file.rb', line 279

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["firmware.Distributable", "firmware.DriverDistributable", "firmware.ServerConfigurationUtilityDistributable", "software.ApplianceDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable", "softwarerepository.OperatingSystemFile"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["firmware.Distributable", "firmware.DriverDistributable", "firmware.ServerConfigurationUtilityDistributable", "software.ApplianceDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable", "softwarerepository.OperatingSystemFile"])
  return false unless object_type_validator.valid?(@object_type)
  import_action_validator = EnumAttributeValidator.new('String', ["None", "GeneratePreSignedUploadUrl", "GeneratePreSignedDownloadUrl", "CompleteImportProcess", "MarkImportFailed", "PreCache", "Cancel", "Extract", "Evict"])
  return false unless import_action_validator.valid?(@import_action)
  import_state_validator = EnumAttributeValidator.new('String', ["ReadyForImport", "Importing", "Imported", "PendingExtraction", "Extracting", "Extracted", "Failed", "MetaOnly", "ReadyForCache", "Caching", "Cached", "CachingFailed", "Corrupted", "Evicted", "Invalid"])
  return false unless import_state_validator.valid?(@import_state)
  return false if !@name.nil? && @name.to_s.length > 128
  true && super
end