Class: IntersightClient::SoftwareSolutionDistributable

Inherits:
FirmwareBaseDistributable show all
Defined in:
lib/intersight_client/models/software_solution_distributable.rb

Overview

A solution image distributed by Cisco.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from FirmwareBaseDistributable

#bundle_type, #component_meta, #distributable_metas, #guid, #image_type, #mdfid, #model, #platform_type, #recommended_build, #release, #release_notes_url, #software_type_id, #supported_models, #vendor

Attributes inherited from SoftwarerepositoryFile

#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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 113

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

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

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

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

  if attributes.key?(:'sub_type')
    self.sub_type = attributes[:'sub_type']
  else
    self.sub_type = 'osimage'
  end

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

Instance Attribute Details

#catalogObject

Returns the value of attribute catalog.



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

def catalog
  @catalog
end

#class_idObject

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/software_solution_distributable.rb', line 20

def class_id
  @class_id
end

#file_pathObject

The path of the file in S3/minio bucket.



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

def file_path
  @file_path
end

#object_typeObject

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

def object_type
  @object_type
end

#solution_nameObject

The name of the solution in which the image belongs.



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

def solution_name
  @solution_name
end

#sub_typeObject

The type of the file like OS image, Script etc. * ‘osimage` - The solution OS image for deployment. * `script` - The Python script for the solution VM configuration and deployment.



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

def sub_type
  @sub_type
end

Class Method Details

.acceptable_attribute_mapObject

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



76
77
78
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 76

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



71
72
73
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 71

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'file_path' => :'FilePath',
    :'solution_name' => :'SolutionName',
    :'sub_type' => :'SubType',
    :'catalog' => :'Catalog'
  }
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



247
248
249
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 247

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



99
100
101
102
103
104
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 99

def self.openapi_all_of
  [
  :'FirmwareBaseDistributable',
  :'SoftwareSolutionDistributableAllOf'
  ]
end

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



107
108
109
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 107

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



93
94
95
96
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 93

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

.openapi_typesObject

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 81

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'file_path' => :'String',
    :'solution_name' => :'String',
    :'sub_type' => :'String',
    :'catalog' => :'SoftwarerepositoryCatalogRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



221
222
223
224
225
226
227
228
229
230
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      file_path == o.file_path &&
      solution_name == o.solution_name &&
      sub_type == o.sub_type &&
      catalog == o.catalog && 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



278
279
280
281
282
283
284
285
286
287
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
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 278

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



349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 349

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 254

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 234

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



240
241
242
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 240

def hash
  [class_id, object_type, file_path, solution_name, sub_type, catalog].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 162

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



325
326
327
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 325

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 331

def to_hash
  hash = super
  SoftwareSolutionDistributable.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = SoftwareSolutionDistributable.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



319
320
321
# File 'lib/intersight_client/models/software_solution_distributable.rb', line 319

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["software.SolutionDistributable"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["software.SolutionDistributable"])
  return false unless object_type_validator.valid?(@object_type)
  sub_type_validator = EnumAttributeValidator.new('String', ["osimage", "script"])
  return false unless sub_type_validator.valid?(@sub_type)
  true && super
end