Class: IntersightClient::HyperflexAlarm

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

Overview

An alarm representing a fault in the HyperFlex cluster configuration or hardware.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 179

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'entity_type')
    self.entity_type = attributes[:'entity_type']
  else
    self.entity_type = 'UNKNOWN'
  end

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

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'UNKNOWN'
  end

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

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

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

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

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

Instance Attribute Details

#acknowledged ⇒ Object

The acknowledgement state of the alarm. It is ‘true’ when the alarm is acknowledged and false otherwise.



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

def acknowledged
  @acknowledged
end

#acknowledged_by ⇒ Object

The username of the user who acknowledged the alarm.



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

def acknowledged_by
  @acknowledged_by
end

#acknowledged_time ⇒ Object

The time when the alarm was acknowledged, represented as a Unix timestamp.



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

def acknowledged_time
  @acknowledged_time
end

#acknowledged_time_as_utc ⇒ Object

The time when the alarm was acknowledged in ISO 6801 format.



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

def acknowledged_time_as_utc
  @acknowledged_time_as_utc
end

#ancestor_mos ⇒ Object

An array of relationships to hyperflexBaseCluster resources.



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

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

def class_id
  @class_id
end

#cluster ⇒ Object

Returns the value of attribute cluster.



73
74
75
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 73

def cluster
  @cluster
end

#description ⇒ Object

The description of the alarm which includes information about the fault that triggered the alarm.



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

def description
  @description
end

#entity_data ⇒ Object

The data pertaining to this entity.



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

def entity_data
  @entity_data
end

#entity_name ⇒ Object

The name of entity which triggered the alarm.



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

def entity_name
  @entity_name
end

#entity_type ⇒ Object

The type of entity which triggered the alarm. For example, this can be the cluster, a node, or VM running on the cluster. * ‘UNKNOWN` - The type of entity is not known. * `DISK` - The entity is a physical storage device. * `NODE` - The entity is a HyperFlex cluster node. * `CLUSTER` - The entity is the HyperFlex cluster itself. * `DATASTORE` - The entity is a logical datastore configured on the HyperFlex cluster. * `ZONE` - The entity is a logical or physical zone configured on the HyperFlex cluster. * `VIRTUALMACHINE` - The entity is a virtual machine running on the HyperFlex cluster.



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

def entity_type
  @entity_type
end

#entity_uu_id ⇒ Object

The unique identifier of the entity which triggered the alarm.



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

def entity_uu_id
  @entity_uu_id
end

#message ⇒ Object

The localized message displayed to the user which describes the alarm.



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

def message
  @message
end

#name ⇒ Object

The name of the alarm. This name identifies the type of alarm that was triggered.



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

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/hyperflex_alarm.rb', line 23

def object_type
  @object_type
end

#status ⇒ Object

The severity of the alarm. * ‘UNKNOWN` - The alarm status is not known. * `CLEARED` - The event that triggered the alarm has been remedied and no longer requires the user’s attention. * ‘INFO` - The alarm represents a message that does not require the user’s immediate attention. * ‘WARNING` - The alarm represents a moderate fault. * `CRITICAL` - The alarm represents a critical fault.



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

def status
  @status
end

#triggered_time ⇒ Object

The time when alarm was triggered as a Unix timestamp.



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

def triggered_time
  @triggered_time
end

#triggered_time_as_utc ⇒ Object

The time when alarm was triggered in ISO 6801 UTC format.



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

def triggered_time_as_utc
  @triggered_time_as_utc
end

#uuid ⇒ Object

The unique identifier for this alarm instance.



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

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



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

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)



123
124
125
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 123

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.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 98

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'acknowledged' => :'Acknowledged',
    :'acknowledged_by' => :'AcknowledgedBy',
    :'acknowledged_time' => :'AcknowledgedTime',
    :'acknowledged_time_as_utc' => :'AcknowledgedTimeAsUtc',
    :'description' => :'Description',
    :'entity_data' => :'EntityData',
    :'entity_name' => :'EntityName',
    :'entity_type' => :'EntityType',
    :'entity_uu_id' => :'EntityUuId',
    :'message' => :'Message',
    :'name' => :'Name',
    :'status' => :'Status',
    :'triggered_time' => :'TriggeredTime',
    :'triggered_time_as_utc' => :'TriggeredTimeAsUtc',
    :'uuid' => :'Uuid',
    :'ancestor_mos' => :'AncestorMos',
    :'cluster' => :'Cluster'
  }
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



394
395
396
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 394

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



165
166
167
168
169
170
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 165

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



173
174
175
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 173

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



158
159
160
161
162
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 158

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

.openapi_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 133

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'acknowledged' => :'Boolean',
    :'acknowledged_by' => :'String',
    :'acknowledged_time' => :'Integer',
    :'acknowledged_time_as_utc' => :'String',
    :'description' => :'String',
    :'entity_data' => :'String',
    :'entity_name' => :'String',
    :'entity_type' => :'String',
    :'entity_uu_id' => :'String',
    :'message' => :'String',
    :'name' => :'String',
    :'status' => :'String',
    :'triggered_time' => :'Integer',
    :'triggered_time_as_utc' => :'String',
    :'uuid' => :'String',
    :'ancestor_mos' => :'Array<HyperflexBaseClusterRelationship>',
    :'cluster' => :'HyperflexClusterRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 355

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 &&
      acknowledged_by == o.acknowledged_by &&
      acknowledged_time == o.acknowledged_time &&
      acknowledged_time_as_utc == o.acknowledged_time_as_utc &&
      description == o.description &&
      entity_data == o.entity_data &&
      entity_name == o.entity_name &&
      entity_type == o.entity_type &&
      entity_uu_id == o.entity_uu_id &&
      message == o.message &&
      name == o.name &&
      status == o.status &&
      triggered_time == o.triggered_time &&
      triggered_time_as_utc == o.triggered_time_as_utc &&
      uuid == o.uuid &&
      ancestor_mos == o.ancestor_mos &&
      cluster == o.cluster && 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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 425

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



496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 496

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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 401

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


381
382
383
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 381

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



387
388
389
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 387

def hash
  [class_id, object_type, acknowledged, acknowledged_by, acknowledged_time, acknowledged_time_as_utc, description, entity_data, entity_name, entity_type, entity_uu_id, message, name, status, triggered_time, triggered_time_as_utc, uuid, ancestor_mos, cluster].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



284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 284

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



472
473
474
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 472

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



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 478

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



466
467
468
 
# File 'lib/intersight_client/models/hyperflex_alarm.rb', line 466

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.Alarm"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.Alarm"])
  return false unless object_type_validator.valid?(@object_type)
  entity_type_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "DISK", "NODE", "CLUSTER", "DATASTORE", "ZONE", "VIRTUALMACHINE"])
  return false unless entity_type_validator.valid?(@entity_type)
  status_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "CLEARED", "INFO", "WARNING", "CRITICAL"])
  return false unless status_validator.valid?(@status)
  true && super
end