Class: IntersightClient::AssetDeployment

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

Overview

Contains information about Deployments associated with consumption-based subscriptions. We listen to messages sent by Cisco Install Base and create/update an instance of this object.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

  if attributes.key?(:'license_type')
    self.license_type = attributes[:'license_type']
  else
    self.license_type = 'Base'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#alarm_infoObject

Returns the value of attribute alarm_info.



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

def alarm_info
  @alarm_info
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/asset_deployment.rb', line 20

def class_id
  @class_id
end

#deployment_ref_idObject

Identifies the consumption-based subscription’s deployment.



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

def deployment_ref_id
  @deployment_ref_id
end

#devicesObject

An array of relationships to assetDeploymentDevice resources.



52
53
54
# File 'lib/intersight_client/models/asset_deployment.rb', line 52

def devices
  @devices
end

#end_customerObject

Returns the value of attribute end_customer.



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

def end_customer
  @end_customer
end

#end_dateObject

End Date for the consumption-based subscription’s deployment.



33
34
35
# File 'lib/intersight_client/models/asset_deployment.rb', line 33

def end_date
  @end_date
end

#license_typeObject

Active license tier for the purchased Cisco device’s deployment. * Base - Base as a License type. It is default license type. * Essential - Essential as a License type. * Standard - Standard as a License type. * Advantage - Advantage as a License type. * Premier - Premier as a License type. * IWO-Essential - IWO-Essential as a License type. * IWO-Advantage - IWO-Advantage as a License type. * IWO-Premier - IWO-Premier as a License type.



36
37
38
# File 'lib/intersight_client/models/asset_deployment.rb', line 36

def license_type
  @license_type
end

#mlb_offer_typeObject

Identifier for consumption based pricing. MLB refers to MultiLine Bundle.



39
40
41
# File 'lib/intersight_client/models/asset_deployment.rb', line 39

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

def object_type
  @object_type
end

#start_dateObject

Start Date for the consumption-based subscription’s deployment.



42
43
44
# File 'lib/intersight_client/models/asset_deployment.rb', line 42

def start_date
  @start_date
end

#subscriptionObject

Returns the value of attribute subscription.



54
55
56
# File 'lib/intersight_client/models/asset_deployment.rb', line 54

def subscription
  @subscription
end

#subscription_ref_idObject

Identifies the consumption-based subscription.



45
46
47
# File 'lib/intersight_client/models/asset_deployment.rb', line 45

def subscription_ref_id
  @subscription_ref_id
end

#unit_of_measureObject

Returns the value of attribute unit_of_measure.



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

def unit_of_measure
  @unit_of_measure
end

#workloadsObject

Returns the value of attribute workloads.



49
50
51
# File 'lib/intersight_client/models/asset_deployment.rb', line 49

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



104
105
106
# File 'lib/intersight_client/models/asset_deployment.rb', line 104

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)



99
100
101
# File 'lib/intersight_client/models/asset_deployment.rb', line 99

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

.attribute_mapObject

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/intersight_client/models/asset_deployment.rb', line 79

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'alarm_info' => :'AlarmInfo',
    :'deployment_ref_id' => :'DeploymentRefId',
    :'end_customer' => :'EndCustomer',
    :'end_date' => :'EndDate',
    :'license_type' => :'LicenseType',
    :'mlb_offer_type' => :'MlbOfferType',
    :'start_date' => :'StartDate',
    :'subscription_ref_id' => :'SubscriptionRefId',
    :'unit_of_measure' => :'UnitOfMeasure',
    :'workloads' => :'Workloads',
    :'devices' => :'Devices',
    :'subscription' => :'Subscription'
  }
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



334
335
336
# File 'lib/intersight_client/models/asset_deployment.rb', line 334

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



140
141
142
143
144
145
# File 'lib/intersight_client/models/asset_deployment.rb', line 140

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

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



148
149
150
# File 'lib/intersight_client/models/asset_deployment.rb', line 148

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



129
130
131
132
133
134
135
136
137
# File 'lib/intersight_client/models/asset_deployment.rb', line 129

def self.openapi_nullable
  Set.new([
    :'alarm_info',
    :'end_customer',
    :'unit_of_measure',
    :'workloads',
    :'devices',
  ])
end

.openapi_typesObject

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/intersight_client/models/asset_deployment.rb', line 109

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'alarm_info' => :'AssetDeploymentAlarmInfo',
    :'deployment_ref_id' => :'String',
    :'end_customer' => :'AssetCustomerInformation',
    :'end_date' => :'Time',
    :'license_type' => :'String',
    :'mlb_offer_type' => :'String',
    :'start_date' => :'Time',
    :'subscription_ref_id' => :'String',
    :'unit_of_measure' => :'Array<AssetMeteringType>',
    :'workloads' => :'Array<String>',
    :'devices' => :'Array<AssetDeploymentDeviceRelationship>',
    :'subscription' => :'AssetSubscriptionRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'lib/intersight_client/models/asset_deployment.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      alarm_info == o.alarm_info &&
      deployment_ref_id == o.deployment_ref_id &&
      end_customer == o.end_customer &&
      end_date == o.end_date &&
      license_type == o.license_type &&
      mlb_offer_type == o.mlb_offer_type &&
      start_date == o.start_date &&
      subscription_ref_id == o.subscription_ref_id &&
      unit_of_measure == o.unit_of_measure &&
      workloads == o.workloads &&
      devices == o.devices &&
      subscription == o.subscription && 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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/intersight_client/models/asset_deployment.rb', line 365

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



436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/intersight_client/models/asset_deployment.rb', line 436

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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
# File 'lib/intersight_client/models/asset_deployment.rb', line 341

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


321
322
323
# File 'lib/intersight_client/models/asset_deployment.rb', line 321

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



327
328
329
# File 'lib/intersight_client/models/asset_deployment.rb', line 327

def hash
  [class_id, object_type, alarm_info, deployment_ref_id, end_customer, end_date, license_type, mlb_offer_type, start_date, subscription_ref_id, unit_of_measure, workloads, devices, subscription].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/intersight_client/models/asset_deployment.rb', line 241

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



412
413
414
# File 'lib/intersight_client/models/asset_deployment.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'lib/intersight_client/models/asset_deployment.rb', line 418

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



406
407
408
# File 'lib/intersight_client/models/asset_deployment.rb', line 406

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.Deployment"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.Deployment"])
  return false unless object_type_validator.valid?(@object_type)
  license_type_validator = EnumAttributeValidator.new('String', ["Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier"])
  return false unless license_type_validator.valid?(@license_type)
  true && super
end