Class: IntersightClient::CondAlarm

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

Overview

A state-full entity representing a found problem. Alarms can be reported by the managed system itself or can be determined by Intersight.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
289
290
291
292
293
294
295
296
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 187

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

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

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

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

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

  if attributes.key?(:'affected_mo_display_name')
    self.affected_mo_display_name = attributes[:'affected_mo_display_name']
  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?(:'affected_object')
    self.affected_object = attributes[:'affected_object']
  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?(:'ms_affected_object')
    self.ms_affected_object = attributes[:'ms_affected_object']
  end

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

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

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

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

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

Instance Attribute Details

#acknowledge ⇒ Object

Alarm acknowledgment state. Default value is None. * ‘None` - The Enum value None represents that the alarm is not acknowledged and is included as part of health status and overall alarm count. * `Acknowledge` - The Enum value Acknowledge represents that the alarm is acknowledged by user. The alarm will be ignored from the health status and overall alarm count.



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

def acknowledge
  @acknowledge
end

#acknowledge_by ⇒ Object

User who acknowledged the alarm.



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

def acknowledge_by
  @acknowledge_by
end

#acknowledge_time ⇒ Object

Time at which the alarm was acknowledged by the user.



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

def acknowledge_time
  @acknowledge_time
end

#affected_mo ⇒ Object

Returns the value of attribute affected_mo.



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

def affected_mo
  @affected_mo
end

#affected_mo_display_name ⇒ Object

Display name of the affected object on which the alarm is raised. The name uniquely identifies an alarm target such that it can be distinguished from similar objects managed by Intersight.



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

def affected_mo_display_name
  @affected_mo_display_name
end

#affected_mo_id ⇒ Object

MoId of the affected object from the managed system’s point of view.



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

def affected_mo_id
  @affected_mo_id
end

#affected_mo_type ⇒ Object

Managed system affected object type. For example Adaptor, FI, CIMC.



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

def affected_mo_type
  @affected_mo_type
end

#affected_object ⇒ Object

A unique key for an alarm instance, consists of a combination of a unique system name and msAffectedObject.



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

def affected_object
  @affected_object
end

#ancestor_mo_id ⇒ Object

Parent MoId of the fault from managed system. For example, Blade moid for adaptor fault.



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

def ancestor_mo_id
  @ancestor_mo_id
end

#ancestor_mo_type ⇒ Object

Parent MO type of the fault from managed system. For example, Blade for adaptor fault.



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

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

def class_id
  @class_id
end

#code ⇒ Object

A unique alarm code. For alarms mapped from UCS faults, this will be the same as the UCS fault code.



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

def code
  @code
end

#creation_time ⇒ Object

The time the alarm was created.



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

def creation_time
  @creation_time
end

#description ⇒ Object

A longer description of the alarm than the name. The description contains details of the component reporting the issue.



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

def description
  @description
end

#last_transition_time ⇒ Object

The time the alarm last had a change in severity.



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

def last_transition_time
  @last_transition_time
end

#ms_affected_object ⇒ Object

A unique key for the alarm from the managed system’s point of view. For example, in the case of UCS, this is the fault’s dn.



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

def ms_affected_object
  @ms_affected_object
end

#name ⇒ Object

Uniquely identifies the type of alarm. For alarms originating from Intersight, this will be a descriptive name. For alarms that are mapped from faults, the name will be derived from fault properties. For example, alarms mapped from UCS faults will use a prefix of UCS and appended with the fault code.



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

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

def object_type
  @object_type
end

#orig_severity ⇒ Object

The original severity when the alarm was first created. * ‘None` - The Enum value None represents that there is no severity. * `Info` - The Enum value Info represents the Informational level of severity. * `Critical` - The Enum value Critical represents the Critical level of severity. * `Warning` - The Enum value Warning represents the Warning level of severity. * `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.



71
72
73
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 71

def orig_severity
  @orig_severity
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



78
79
80
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 78

def registered_device
  @registered_device
end

#severity ⇒ Object

The severity of the alarm. Valid values are Critical, Warning, Info, and Cleared. * ‘None` - The Enum value None represents that there is no severity. * `Info` - The Enum value Info represents the Informational level of severity. * `Critical` - The Enum value Critical represents the Critical level of severity. * `Warning` - The Enum value Warning represents the Warning level of severity. * `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.



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

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)



135
136
137
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 135

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)



130
131
132
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 130

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'acknowledge' => :'Acknowledge',
    :'acknowledge_by' => :'AcknowledgeBy',
    :'acknowledge_time' => :'AcknowledgeTime',
    :'affected_mo_display_name' => :'AffectedMoDisplayName',
    :'affected_mo_id' => :'AffectedMoId',
    :'affected_mo_type' => :'AffectedMoType',
    :'affected_object' => :'AffectedObject',
    :'ancestor_mo_id' => :'AncestorMoId',
    :'ancestor_mo_type' => :'AncestorMoType',
    :'code' => :'Code',
    :'creation_time' => :'CreationTime',
    :'description' => :'Description',
    :'last_transition_time' => :'LastTransitionTime',
    :'ms_affected_object' => :'MsAffectedObject',
    :'name' => :'Name',
    :'orig_severity' => :'OrigSeverity',
    :'severity' => :'Severity',
    :'affected_mo' => :'AffectedMo',
    :'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



424
425
426
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 424

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



173
174
175
176
177
178
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 173

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



181
182
183
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 181

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



167
168
169
170
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 167

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'acknowledge' => :'String',
    :'acknowledge_by' => :'String',
    :'acknowledge_time' => :'Time',
    :'affected_mo_display_name' => :'String',
    :'affected_mo_id' => :'String',
    :'affected_mo_type' => :'String',
    :'affected_object' => :'String',
    :'ancestor_mo_id' => :'String',
    :'ancestor_mo_type' => :'String',
    :'code' => :'String',
    :'creation_time' => :'Time',
    :'description' => :'String',
    :'last_transition_time' => :'Time',
    :'ms_affected_object' => :'String',
    :'name' => :'String',
    :'orig_severity' => :'String',
    :'severity' => :'String',
    :'affected_mo' => :'MoBaseMoRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 383

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      acknowledge == o.acknowledge &&
      acknowledge_by == o.acknowledge_by &&
      acknowledge_time == o.acknowledge_time &&
      affected_mo_display_name == o.affected_mo_display_name &&
      affected_mo_id == o.affected_mo_id &&
      affected_mo_type == o.affected_mo_type &&
      affected_object == o.affected_object &&
      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 &&
      ms_affected_object == o.ms_affected_object &&
      name == o.name &&
      orig_severity == o.orig_severity &&
      severity == o.severity &&
      affected_mo == o.affected_mo &&
      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



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 455

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



526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 526

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



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 431

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


411
412
413
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 411

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



417
418
419
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 417

def hash
  [class_id, object_type, acknowledge, acknowledge_by, acknowledge_time, affected_mo_display_name, affected_mo_id, affected_mo_type, affected_object, ancestor_mo_id, ancestor_mo_type, code, creation_time, description, last_transition_time, ms_affected_object, name, orig_severity, severity, affected_mo, 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



300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 300

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



502
503
504
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 502

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



508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 508

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



496
497
498
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 496

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/intersight_client/models/cond_alarm.rb', line 315

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["cond.Alarm"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["cond.Alarm"])
  return false unless object_type_validator.valid?(@object_type)
  acknowledge_validator = EnumAttributeValidator.new('String', ["None", "Acknowledge"])
  return false unless acknowledge_validator.valid?(@acknowledge)
  orig_severity_validator = EnumAttributeValidator.new('String', ["None", "Info", "Critical", "Warning", "Cleared"])
  return false unless orig_severity_validator.valid?(@orig_severity)
  severity_validator = EnumAttributeValidator.new('String', ["None", "Info", "Critical", "Warning", "Cleared"])
  return false unless severity_validator.valid?(@severity)
  true && super
end