Class: IntersightClient::AssetDeviceInformation

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

Overview

Type for saving the device information reported by Cisco Install Base. It is used in asset.SubscriptionDeviceInformation object to save the device information.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetDeviceInformation

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
257
258
259
260
261
262
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 169

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'old_device_status_id')
    self.old_device_status_id = attributes[:'old_device_status_id']
  else
    self.old_device_status_id = OLD_DEVICE_STATUS_ID::N0
  end

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

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

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

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

Instance Attribute Details

#application_name ⇒ Object

Application name reported by Cisco Install Base.



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

def application_name
  @application_name
end

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

def class_id
  @class_id
end

#device_transactions ⇒ Object

Returns the value of attribute device_transactions.



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

def device_transactions
  @device_transactions
end

#end_customer ⇒ Object

Returns the value of attribute end_customer.



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

def end_customer
  @end_customer
end

#instance_id ⇒ Object

Instance number of the device. example "917280220".



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

def instance_id
  @instance_id
end

#item_type ⇒ Object

Item type flag. example ATO, Child, Standalone. ATO - refers to Cisco Block based major device. Child - refers to Child device part of an ATO block. Standalone - refers to a device that is managed and configured as an individual entity with limited capacity.



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

def item_type
  @item_type
end

#mlb_offer_type ⇒ Object

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



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

def mlb_offer_type
  @mlb_offer_type
end

#mlb_product_id ⇒ Object

Identifier corresponding to MLB Product Name. MLB refers to MultiLine Bundle.



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

def mlb_product_id
  @mlb_product_id
end

#mlb_product_name ⇒ Object

Product Name for the device. It is used to determine if the server is to be billed as a UCS compute device or a storage cluster. MLB refers to MultiLine Bundle.



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

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

def object_type
  @object_type
end

#old_device_id ⇒ Object

Unique identifier of old Cisco device. It is the device ID of old Cisco device, which got replaced by the new device.



48
49
50
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 48

def old_device_id
  @old_device_id
end

#old_device_status_description ⇒ Object

Description of status of old Cisco device, which got replaced by the new device.



51
52
53
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 51

def old_device_status_description
  @old_device_status_description
end

#old_device_status_id ⇒ Object

Status ID of old Cisco device, which got replaced by the new device. * 0 - A default value to catch cases where device status is not correctly detected. * 10000 - Device is installed successfully. * 1010041 - Device is currently in Return Material Authorization process. * 10005 - Device is replaced successfully with another device. * 10007 - Device is returned succcessfuly. * 10009 - Device is terminated at customer’s end.



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

def old_device_status_id
  @old_device_status_id
end

#old_instance_id ⇒ Object

Instance number of the old device, which got replaced by the new device.



57
58
59
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 57

def old_instance_id
  @old_instance_id
end

#product_family ⇒ Object

Product Family is the field used to identify the hypervisor type. example "ESXi".



60
61
62
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 60

def product_family
  @product_family
end

#product_type ⇒ Object

Product type helps to determine if device has to be billed using consumption metering. example "SERVER".



63
64
65
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 63

def product_type
  @product_type
end

#unit_of_measure ⇒ Object

Unit of Measure is flag used to identify the type of metric being pushed. example - "STORAGE" for hardware metrics , "VM" - for hypervisor metrics. * None - A default value to catch cases where unit of measure is not correctly detected. * STORAGE - The metric type of the device is a storage metric. * NODE - The metric type of the device is a hardware metric. * VM - The metric type of the device is a hypervisor metric.



66
67
68
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 66

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



119
120
121
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 119

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)



114
115
116
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 114

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'application_name' => :'ApplicationName',
    :'device_transactions' => :'DeviceTransactions',
    :'end_customer' => :'EndCustomer',
    :'instance_id' => :'InstanceId',
    :'item_type' => :'ItemType',
    :'mlb_offer_type' => :'MlbOfferType',
    :'mlb_product_id' => :'MlbProductId',
    :'mlb_product_name' => :'MlbProductName',
    :'old_device_id' => :'OldDeviceId',
    :'old_device_status_description' => :'OldDeviceStatusDescription',
    :'old_device_status_id' => :'OldDeviceStatusId',
    :'old_instance_id' => :'OldInstanceId',
    :'product_family' => :'ProductFamily',
    :'product_type' => :'ProductType',
    :'unit_of_measure' => :'UnitOfMeasure'
  }
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



374
375
376
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 374

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/asset_device_information.rb', line 155

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'application_name' => :'String',
    :'device_transactions' => :'Array<AssetDeviceTransaction>',
    :'end_customer' => :'AssetCustomerInformation',
    :'instance_id' => :'String',
    :'item_type' => :'String',
    :'mlb_offer_type' => :'String',
    :'mlb_product_id' => :'Integer',
    :'mlb_product_name' => :'String',
    :'old_device_id' => :'String',
    :'old_device_status_description' => :'String',
    :'old_device_status_id' => :'Integer',
    :'old_instance_id' => :'String',
    :'product_family' => :'String',
    :'product_type' => :'String',
    :'unit_of_measure' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 337

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      application_name == o.application_name &&
      device_transactions == o.device_transactions &&
      end_customer == o.end_customer &&
      instance_id == o.instance_id &&
      item_type == o.item_type &&
      mlb_offer_type == o.mlb_offer_type &&
      mlb_product_id == o.mlb_product_id &&
      mlb_product_name == o.mlb_product_name &&
      old_device_id == o.old_device_id &&
      old_device_status_description == o.old_device_status_description &&
      old_device_status_id == o.old_device_status_id &&
      old_instance_id == o.old_instance_id &&
      product_family == o.product_family &&
      product_type == o.product_type &&
      unit_of_measure == o.unit_of_measure && 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



405
406
407
408
409
410
411
412
413
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
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 405

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



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 476

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 381

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


361
362
363
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



367
368
369
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 367

def hash
  [class_id, object_type, application_name, device_transactions, end_customer, instance_id, item_type, mlb_offer_type, mlb_product_id, mlb_product_name, old_device_id, old_device_status_description, old_device_status_id, old_instance_id, product_family, product_type, unit_of_measure].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



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 266

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



452
453
454
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 452

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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 458

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



446
447
448
 
# File 'lib/intersight_client/models/asset_device_information.rb', line 446

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.DeviceInformation"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.DeviceInformation"])
  return false unless object_type_validator.valid?(@object_type)
  old_device_status_id_validator = EnumAttributeValidator.new('Integer', [0, 10000, 1010041, 10005, 10007, 10009])
  return false unless old_device_status_id_validator.valid?(@old_device_status_id)
  unit_of_measure_validator = EnumAttributeValidator.new('String', ["None", "STORAGE", "NODE", "VM"])
  return false unless unit_of_measure_validator.valid?(@unit_of_measure)
  true && super
end