Class: IntersightClient::FaultInstance

Inherits:
InventoryBase show all
Defined in:
lib/intersight_client/models/fault_instance.rb

Overview

An endpoint anomaly is represented by this object.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from InventoryBase

#device_mo_id, #dn, #rn

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/intersight_client/models/fault_instance.rb', line 185

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#acknowledged ⇒ Object

The user acknowledgement state of the fault.



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

def acknowledged
  @acknowledged
end

#affected_dn ⇒ Object

The Distinguished Name of the Managed object which was affected.



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

def affected_dn
  @affected_dn
end

#affected_mo ⇒ Object

Returns the value of attribute affected_mo.



70
71
72
 
# File 'lib/intersight_client/models/fault_instance.rb', line 70

def affected_mo
  @affected_mo
end

#affected_mo_id ⇒ Object

Managed object Id which was affected.



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

def affected_mo_id
  @affected_mo_id
end

#affected_mo_type ⇒ Object

Managed object type which was affected.



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

def affected_mo_type
  @affected_mo_type
end

#ancestor_mo ⇒ Object

Returns the value of attribute ancestor_mo.



72
73
74
 
# File 'lib/intersight_client/models/fault_instance.rb', line 72

def ancestor_mo
  @ancestor_mo
end

#ancestor_mo_id ⇒ Object

Object Id of the parent of the Managed object which was affected.



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

def ancestor_mo_id
  @ancestor_mo_id
end

#ancestor_mo_type ⇒ Object

Object type of the parent of the Managed object which was affected.



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

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

def class_id
  @class_id
end

#code ⇒ Object

Numerical fault code of the fault found.



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

def code
  @code
end

#creation_time ⇒ Object

The time of creation of the fault instance.



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

def creation_time
  @creation_time
end

#description ⇒ Object

Detailed message of the fault.



50
51
52
 
# File 'lib/intersight_client/models/fault_instance.rb', line 50

def description
  @description
end

#inventory_device_info ⇒ Object

Returns the value of attribute inventory_device_info.



74
75
76
 
# File 'lib/intersight_client/models/fault_instance.rb', line 74

def inventory_device_info
  @inventory_device_info
end

#last_transition_time ⇒ Object

Last transition time of the fault.



53
54
55
 
# File 'lib/intersight_client/models/fault_instance.rb', line 53

def last_transition_time
  @last_transition_time
end

#num_occurrences ⇒ Object

The number of times this fault has occured.



56
57
58
 
# File 'lib/intersight_client/models/fault_instance.rb', line 56

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

def object_type
  @object_type
end

#original_severity ⇒ Object

Current Severity of the fault found.



59
60
61
 
# File 'lib/intersight_client/models/fault_instance.rb', line 59

def original_severity
  @original_severity
end

#previous_severity ⇒ Object

The Severity of the fault prior to user update.



62
63
64
 
# File 'lib/intersight_client/models/fault_instance.rb', line 62

def previous_severity
  @previous_severity
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



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

def registered_device
  @registered_device
end

#rule ⇒ Object

The rule that is responsible for generation of the fault.



65
66
67
 
# File 'lib/intersight_client/models/fault_instance.rb', line 65

def rule
  @rule
end

#severity ⇒ Object

Severity of the fault found.



68
69
70
 
# File 'lib/intersight_client/models/fault_instance.rb', line 68

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



133
134
135
 
# File 'lib/intersight_client/models/fault_instance.rb', line 133

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)



128
129
130
 
# File 'lib/intersight_client/models/fault_instance.rb', line 128

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.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/intersight_client/models/fault_instance.rb', line 101

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'acknowledged' => :'Acknowledged',
    :'affected_dn' => :'AffectedDn',
    :'affected_mo_id' => :'AffectedMoId',
    :'affected_mo_type' => :'AffectedMoType',
    :'ancestor_mo_id' => :'AncestorMoId',
    :'ancestor_mo_type' => :'AncestorMoType',
    :'code' => :'Code',
    :'creation_time' => :'CreationTime',
    :'description' => :'Description',
    :'last_transition_time' => :'LastTransitionTime',
    :'num_occurrences' => :'NumOccurrences',
    :'original_severity' => :'OriginalSeverity',
    :'previous_severity' => :'PreviousSeverity',
    :'rule' => :'Rule',
    :'severity' => :'Severity',
    :'affected_mo' => :'AffectedMo',
    :'ancestor_mo' => :'AncestorMo',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'registered_device' => :'RegisteredDevice'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



380
381
382
 
# File 'lib/intersight_client/models/fault_instance.rb', line 380

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



171
172
173
174
175
176
 
# File 'lib/intersight_client/models/fault_instance.rb', line 171

def self.openapi_all_of
  [
  :'FaultInstanceAllOf',
  :'InventoryBase'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



179
180
181
 
# File 'lib/intersight_client/models/fault_instance.rb', line 179

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



165
166
167
168
 
# File 'lib/intersight_client/models/fault_instance.rb', line 165

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'acknowledged' => :'String',
    :'affected_dn' => :'String',
    :'affected_mo_id' => :'String',
    :'affected_mo_type' => :'String',
    :'ancestor_mo_id' => :'String',
    :'ancestor_mo_type' => :'String',
    :'code' => :'String',
    :'creation_time' => :'String',
    :'description' => :'String',
    :'last_transition_time' => :'String',
    :'num_occurrences' => :'Integer',
    :'original_severity' => :'String',
    :'previous_severity' => :'String',
    :'rule' => :'String',
    :'severity' => :'String',
    :'affected_mo' => :'InventoryBaseRelationship',
    :'ancestor_mo' => :'InventoryBaseRelationship',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/intersight_client/models/fault_instance.rb', line 339

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      acknowledged == o.acknowledged &&
      affected_dn == o.affected_dn &&
      affected_mo_id == o.affected_mo_id &&
      affected_mo_type == o.affected_mo_type &&
      ancestor_mo_id == o.ancestor_mo_id &&
      ancestor_mo_type == o.ancestor_mo_type &&
      code == o.code &&
      creation_time == o.creation_time &&
      description == o.description &&
      last_transition_time == o.last_transition_time &&
      num_occurrences == o.num_occurrences &&
      original_severity == o.original_severity &&
      previous_severity == o.previous_severity &&
      rule == o.rule &&
      severity == o.severity &&
      affected_mo == o.affected_mo &&
      ancestor_mo == o.ancestor_mo &&
      inventory_device_info == o.inventory_device_info &&
      registered_device == o.registered_device && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
443
444
445
446
447
448
 
# File 'lib/intersight_client/models/fault_instance.rb', line 411

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/intersight_client/models/fault_instance.rb', line 482

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/intersight_client/models/fault_instance.rb', line 387

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



373
374
375
 
# File 'lib/intersight_client/models/fault_instance.rb', line 373

def hash
  [class_id, object_type, acknowledged, affected_dn, affected_mo_id, affected_mo_type, ancestor_mo_id, ancestor_mo_type, code, creation_time, description, last_transition_time, num_occurrences, original_severity, previous_severity, rule, severity, affected_mo, ancestor_mo, inventory_device_info, 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



292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/intersight_client/models/fault_instance.rb', line 292

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:

  • Returns the object in the form of hash



458
459
460
 
# File 'lib/intersight_client/models/fault_instance.rb', line 458

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/intersight_client/models/fault_instance.rb', line 464

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



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

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



307
308
309
310
311
312
313
314
315
 
# File 'lib/intersight_client/models/fault_instance.rb', line 307

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