Class: IntersightClient::AssetSubscriptionDeviceContractInformation

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

Overview

Contains information about Cisco devices associated with consumption-based subscriptions. In addition to device installation status and customer address, information about returns and replacements is also recorded here. 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 = {}) ⇒ AssetSubscriptionDeviceContractInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 122

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#device_contract_information ⇒ Object

Returns the value of attribute device_contract_information.



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

def device_contract_information
  @device_contract_information
end

#device_id ⇒ Object

Unique identifier of the Cisco device.



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

def device_id
  @device_id
end

#device_information ⇒ Object

Returns the value of attribute device_information.



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

def device_information
  @device_information
end

#device_pid ⇒ Object

Product identifier for the specified Cisco device. It is used to distinguish between HyperFlex and UCS devices.



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

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

def object_type
  @object_type
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



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

def registered_device
  @registered_device
end

#subscription_ref_id ⇒ Object

Identifies the consumption-based subscription.



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

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



82
83
84
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 82

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)



77
78
79
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 77

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.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 63

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'device_id' => :'DeviceId',
    :'device_information' => :'DeviceInformation',
    :'device_pid' => :'DevicePid',
    :'subscription_ref_id' => :'SubscriptionRefId',
    :'device_contract_information' => :'DeviceContractInformation',
    :'registered_device' => :'RegisteredDevice'
  }
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



252
253
254
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 252

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



108
109
110
111
112
113
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 108

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



116
117
118
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 116

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
105
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 87

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'device_id' => :'String',
    :'device_information' => :'AssetDeviceInformation',
    :'device_pid' => :'String',
    :'subscription_ref_id' => :'String',
    :'device_contract_information' => :'AssetDeviceContractInformationRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      device_id == o.device_id &&
      device_information == o.device_information &&
      device_pid == o.device_pid &&
      subscription_ref_id == o.subscription_ref_id &&
      device_contract_information == o.device_contract_information &&
      registered_device == o.registered_device && 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



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
316
317
318
319
320
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 283

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 354

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


239
240
241
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 245

def hash
  [class_id, object_type, device_id, device_information, device_pid, subscription_ref_id, device_contract_information, registered_device].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



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

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



330
331
332
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 336

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



324
325
326
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 324

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



192
193
194
195
196
197
198
199
200
 
# File 'lib/intersight_client/models/asset_subscription_device_contract_information.rb', line 192

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.SubscriptionDeviceContractInformation"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.SubscriptionDeviceContractInformation"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end