Class: IntersightClient::AssetDeviceTransactionAllOf

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

Overview

Definition of the list of properties defined in ‘asset.DeviceTransaction’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetDeviceTransactionAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

The action taken by Cisco Install Base on the device.



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

def action
  @action
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_transaction_all_of.rb', line 20

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

def object_type
  @object_type
end

#status_description ⇒ Object

Description of status of Cisco device reported by Cisco Install Base.



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

def status_description
  @status_description
end

#status_id ⇒ Object

Status ID of device reported by Cisco Install Base. * ‘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.



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

def status_id
  @status_id
end

#timestamp ⇒ Object

Timestamp field reported by Cisco Install Base.



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

def timestamp
  @timestamp
end

#transaction_batch_id ⇒ Object

Transaction batch ID reported by Cisco Install Base.



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

def transaction_batch_id
  @transaction_batch_id
end

#transaction_date ⇒ Object

Transaction Date reported by Cisco Install Base.



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

def transaction_date
  @transaction_date
end

#transaction_sequence ⇒ Object

Transaction sequence reported by Cisco Install Base.



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

def transaction_sequence
  @transaction_sequence
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



89
90
91
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 89

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 69

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'action' => :'Action',
    :'status_description' => :'StatusDescription',
    :'status_id' => :'StatusId',
    :'timestamp' => :'Timestamp',
    :'transaction_batch_id' => :'TransactionBatchId',
    :'transaction_date' => :'TransactionDate',
    :'transaction_sequence' => :'TransactionSequence'
  }
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



262
263
264
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 262

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 94

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'action' => :'String',
    :'status_description' => :'String',
    :'status_id' => :'Integer',
    :'timestamp' => :'String',
    :'transaction_batch_id' => :'Integer',
    :'transaction_date' => :'String',
    :'transaction_sequence' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      action == o.action &&
      status_description == o.status_description &&
      status_id == o.status_id &&
      timestamp == o.timestamp &&
      transaction_batch_id == o.transaction_batch_id &&
      transaction_date == o.transaction_date &&
      transaction_sequence == o.transaction_sequence
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



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
321
322
323
324
325
326
327
328
329
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 292

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 363

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 269

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


249
250
251
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 255

def hash
  [class_id, object_type, action, status_description, status_id, timestamp, transaction_batch_id, transaction_date, transaction_sequence].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



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 174

def list_invalid_properties
  invalid_properties = Array.new
  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



339
340
341
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 345

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



333
334
335
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 333

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



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/intersight_client/models/asset_device_transaction_all_of.rb', line 189

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.DeviceTransaction"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.DeviceTransaction"])
  return false unless object_type_validator.valid?(@object_type)
  status_id_validator = EnumAttributeValidator.new('Integer', [0, 10000, 1010041, 10005, 10007, 10009])
  return false unless status_id_validator.valid?(@status_id)
  true
end