Class: OCI::Monitoring::Models::Alarm

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/monitoring/models/alarm.rb

Overview

The properties that define an alarm. For information about alarms, see Alarms Overview.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Constant Summary collapse

SEVERITY_ENUM = 
[
  SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  SEVERITY_ERROR = 'ERROR'.freeze,
  SEVERITY_WARNING = 'WARNING'.freeze,
  SEVERITY_INFO = 'INFO'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MESSAGE_FORMAT_ENUM = 
[
  MESSAGE_FORMAT_RAW = 'RAW'.freeze,
  MESSAGE_FORMAT_PRETTY_JSON = 'PRETTY_JSON'.freeze,
  MESSAGE_FORMAT_ONS_OPTIMIZED = 'ONS_OPTIMIZED'.freeze,
  MESSAGE_FORMAT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Alarm

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :metric_compartment_id (String) —

    The value to assign to the #metric_compartment_id property

  • :metric_compartment_id_in_subtree (BOOLEAN) —

    The value to assign to the #metric_compartment_id_in_subtree property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :resource_group (String) —

    The value to assign to the #resource_group property

  • :query (String) —

    The value to assign to the #query property

  • :resolution (String) —

    The value to assign to the #resolution property

  • :pending_duration (String) —

    The value to assign to the #pending_duration property

  • :severity (String) —

    The value to assign to the #severity property

  • :body (String) —

    The value to assign to the #body property

  • :is_notifications_per_metric_dimension_enabled (BOOLEAN) —

    The value to assign to the #is_notifications_per_metric_dimension_enabled property

  • :message_format (String) —

    The value to assign to the #message_format property

  • :destinations (Array<String>) —

    The value to assign to the #destinations property

  • :repeat_notification_duration (String) —

    The value to assign to the #repeat_notification_duration property

  • :suppression (OCI::Monitoring::Models::Suppression) —

    The value to assign to the #suppression property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
408
409
410
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
449
450
451
452
453
454
455
456
 
# File 'lib/oci/monitoring/models/alarm.rb', line 341

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.metric_compartment_id = attributes[:'metricCompartmentId'] if attributes[:'metricCompartmentId']

  raise 'You cannot provide both :metricCompartmentId and :metric_compartment_id' if attributes.key?(:'metricCompartmentId') && attributes.key?(:'metric_compartment_id')

  self.metric_compartment_id = attributes[:'metric_compartment_id'] if attributes[:'metric_compartment_id']

  self.metric_compartment_id_in_subtree = attributes[:'metricCompartmentIdInSubtree'] unless attributes[:'metricCompartmentIdInSubtree'].nil?

  raise 'You cannot provide both :metricCompartmentIdInSubtree and :metric_compartment_id_in_subtree' if attributes.key?(:'metricCompartmentIdInSubtree') && attributes.key?(:'metric_compartment_id_in_subtree')

  self.metric_compartment_id_in_subtree = attributes[:'metric_compartment_id_in_subtree'] unless attributes[:'metric_compartment_id_in_subtree'].nil?

  self.namespace = attributes[:'namespace'] if attributes[:'namespace']

  self.resource_group = attributes[:'resourceGroup'] if attributes[:'resourceGroup']

  raise 'You cannot provide both :resourceGroup and :resource_group' if attributes.key?(:'resourceGroup') && attributes.key?(:'resource_group')

  self.resource_group = attributes[:'resource_group'] if attributes[:'resource_group']

  self.query = attributes[:'query'] if attributes[:'query']

  self.resolution = attributes[:'resolution'] if attributes[:'resolution']

  self.pending_duration = attributes[:'pendingDuration'] if attributes[:'pendingDuration']

  raise 'You cannot provide both :pendingDuration and :pending_duration' if attributes.key?(:'pendingDuration') && attributes.key?(:'pending_duration')

  self.pending_duration = attributes[:'pending_duration'] if attributes[:'pending_duration']

  self.severity = attributes[:'severity'] if attributes[:'severity']

  self.body = attributes[:'body'] if attributes[:'body']

  self.is_notifications_per_metric_dimension_enabled = attributes[:'isNotificationsPerMetricDimensionEnabled'] unless attributes[:'isNotificationsPerMetricDimensionEnabled'].nil?
  self.is_notifications_per_metric_dimension_enabled = false if is_notifications_per_metric_dimension_enabled.nil? && !attributes.key?(:'isNotificationsPerMetricDimensionEnabled') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isNotificationsPerMetricDimensionEnabled and :is_notifications_per_metric_dimension_enabled' if attributes.key?(:'isNotificationsPerMetricDimensionEnabled') && attributes.key?(:'is_notifications_per_metric_dimension_enabled')

  self.is_notifications_per_metric_dimension_enabled = attributes[:'is_notifications_per_metric_dimension_enabled'] unless attributes[:'is_notifications_per_metric_dimension_enabled'].nil?
  self.is_notifications_per_metric_dimension_enabled = false if is_notifications_per_metric_dimension_enabled.nil? && !attributes.key?(:'isNotificationsPerMetricDimensionEnabled') && !attributes.key?(:'is_notifications_per_metric_dimension_enabled') # rubocop:disable Style/StringLiterals

  self.message_format = attributes[:'messageFormat'] if attributes[:'messageFormat']
  self.message_format = "RAW" if message_format.nil? && !attributes.key?(:'messageFormat') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :messageFormat and :message_format' if attributes.key?(:'messageFormat') && attributes.key?(:'message_format')

  self.message_format = attributes[:'message_format'] if attributes[:'message_format']
  self.message_format = "RAW" if message_format.nil? && !attributes.key?(:'messageFormat') && !attributes.key?(:'message_format') # rubocop:disable Style/StringLiterals

  self.destinations = attributes[:'destinations'] if attributes[:'destinations']

  self.repeat_notification_duration = attributes[:'repeatNotificationDuration'] if attributes[:'repeatNotificationDuration']

  raise 'You cannot provide both :repeatNotificationDuration and :repeat_notification_duration' if attributes.key?(:'repeatNotificationDuration') && attributes.key?(:'repeat_notification_duration')

  self.repeat_notification_duration = attributes[:'repeat_notification_duration'] if attributes[:'repeat_notification_duration']

  self.suppression = attributes[:'suppression'] if attributes[:'suppression']

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

  raise 'You cannot provide both :isEnabled and :is_enabled' if attributes.key?(:'isEnabled') && attributes.key?(:'is_enabled')

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']
end

Instance Attribute Details

#body ⇒ String

The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices.

Example: High CPU usage alert. Follow runbook instructions for resolution.

Returns:

  • (String) 


168
169
170
 
# File 'lib/oci/monitoring/models/alarm.rb', line 168

def body
  @body
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the alarm.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/monitoring/models/alarm.rb', line 63

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


227
228
229
 
# File 'lib/oci/monitoring/models/alarm.rb', line 227

def defined_tags
  @defined_tags
end

#destinations ⇒ Array<String>

[Required] A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a NotificationTopic. Supported destination services: Notifications , Streaming. Limit: One destination per supported destination service.

Returns:

  • (Array<String>) 


192
193
194
 
# File 'lib/oci/monitoring/models/alarm.rb', line 192

def destinations
  @destinations
end

#display_name ⇒ String

[Required] A user-friendly name for the alarm. It does not have to be unique, and it's changeable.

This value determines the title of each alarm notification.

Example: High CPU Utilization

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/monitoring/models/alarm.rb', line 58

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


221
222
223
 
# File 'lib/oci/monitoring/models/alarm.rb', line 221

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the alarm.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/monitoring/models/alarm.rb', line 49

def id
  @id
end

#is_enabled ⇒ BOOLEAN

[Required] Whether the alarm is enabled.

Example: true

Returns:

  • (BOOLEAN) 


215
216
217
 
# File 'lib/oci/monitoring/models/alarm.rb', line 215

def is_enabled
  @is_enabled
end

#is_notifications_per_metric_dimension_enabled ⇒ BOOLEAN

When set to true, splits alarm notifications per metric stream. When set to false, groups alarm notifications across metric streams.

Returns:

  • (BOOLEAN) 


174
175
176
 
# File 'lib/oci/monitoring/models/alarm.rb', line 174

def is_notifications_per_metric_dimension_enabled
  @is_notifications_per_metric_dimension_enabled
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the alarm.

Example: DELETED

Returns:

  • (String) 


234
235
236
 
# File 'lib/oci/monitoring/models/alarm.rb', line 234

def lifecycle_state
  @lifecycle_state
end

#message_format ⇒ String

The format to use for alarm notifications. The formats are: * RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format. * PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only. * ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

Returns:

  • (String) 


182
183
184
 
# File 'lib/oci/monitoring/models/alarm.rb', line 182

def message_format
  @message_format
end

#metric_compartment_id ⇒ String

[Required] The OCID of the compartment containing the metric being evaluated by the alarm.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/monitoring/models/alarm.rb', line 69

def metric_compartment_id
  @metric_compartment_id
end

#metric_compartment_id_in_subtree ⇒ BOOLEAN

When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.

Example: true

Returns:

  • (BOOLEAN) 


80
81
82
 
# File 'lib/oci/monitoring/models/alarm.rb', line 80

def metric_compartment_id_in_subtree
  @metric_compartment_id_in_subtree
end

#namespace ⇒ String

[Required] The source service or application emitting the metric that is evaluated by the alarm.

Example: oci_computeagent

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/monitoring/models/alarm.rb', line 87

def namespace
  @namespace
end

#pending_duration ⇒ String

The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".

The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.

Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING".

The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.

Example: PT5M

Returns:

  • (String) 


152
153
154
 
# File 'lib/oci/monitoring/models/alarm.rb', line 152

def pending_duration
  @pending_duration
end

#query ⇒ String

[Required] The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.

Example of threshold alarm:

CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85

Example of absence alarm:

CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent()

Returns:

  • (String) 


128
129
130
 
# File 'lib/oci/monitoring/models/alarm.rb', line 128

def query
  @query
end

#repeat_notification_duration ⇒ String

The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum: PT1M. Maximum: P30D.

Default value: null (notifications are not re-submitted).

Example: PT2H

Returns:

  • (String) 


203
204
205
 
# File 'lib/oci/monitoring/models/alarm.rb', line 203

def repeat_notification_duration
  @repeat_notification_duration
end

#resolution ⇒ String

The time between calculated aggregation windows for the alarm. Supported value: 1m

Returns:

  • (String) 


133
134
135
 
# File 'lib/oci/monitoring/models/alarm.rb', line 133

def resolution
  @resolution
end

#resource_group ⇒ String

Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Example: frontend-fleet

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/monitoring/models/alarm.rb', line 95

def resource_group
  @resource_group
end

#severity ⇒ String

[Required] The perceived type of response required when the alarm is in the "FIRING" state.

Example: CRITICAL

Returns:

  • (String) 


159
160
161
 
# File 'lib/oci/monitoring/models/alarm.rb', line 159

def severity
  @severity
end

#suppression ⇒ OCI::Monitoring::Models::Suppression

The configuration details for suppressing an alarm.

Returns:



208
209
210
 
# File 'lib/oci/monitoring/models/alarm.rb', line 208

def suppression
  @suppression
end

#time_created ⇒ DateTime

[Required] The date and time the alarm was created. Format defined by RFC3339.

Example: 2019-02-01T01:02:29.600Z

Returns:

  • (DateTime) 


241
242
243
 
# File 'lib/oci/monitoring/models/alarm.rb', line 241

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the alarm was last updated. Format defined by RFC3339.

Example: 2019-02-03T01:02:29.600Z

Returns:

  • (DateTime) 


248
249
250
 
# File 'lib/oci/monitoring/models/alarm.rb', line 248

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/monitoring/models/alarm.rb', line 251

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'metric_compartment_id': :'metricCompartmentId',
    'metric_compartment_id_in_subtree': :'metricCompartmentIdInSubtree',
    'namespace': :'namespace',
    'resource_group': :'resourceGroup',
    'query': :'query',
    'resolution': :'resolution',
    'pending_duration': :'pendingDuration',
    'severity': :'severity',
    'body': :'body',
    'is_notifications_per_metric_dimension_enabled': :'isNotificationsPerMetricDimensionEnabled',
    'message_format': :'messageFormat',
    'destinations': :'destinations',
    'repeat_notification_duration': :'repeatNotificationDuration',
    'suppression': :'suppression',
    'is_enabled': :'isEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



282
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
 
# File 'lib/oci/monitoring/models/alarm.rb', line 282

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'metric_compartment_id': :'String',
    'metric_compartment_id_in_subtree': :'BOOLEAN',
    'namespace': :'String',
    'resource_group': :'String',
    'query': :'String',
    'resolution': :'String',
    'pending_duration': :'String',
    'severity': :'String',
    'body': :'String',
    'is_notifications_per_metric_dimension_enabled': :'BOOLEAN',
    'message_format': :'String',
    'destinations': :'Array<String>',
    'repeat_notification_duration': :'String',
    'suppression': :'OCI::Monitoring::Models::Suppression',
    'is_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/oci/monitoring/models/alarm.rb', line 504

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    metric_compartment_id == other.metric_compartment_id &&
    metric_compartment_id_in_subtree == other.metric_compartment_id_in_subtree &&
    namespace == other.namespace &&
    resource_group == other.resource_group &&
    query == other.query &&
    resolution == other.resolution &&
    pending_duration == other.pending_duration &&
    severity == other.severity &&
    body == other.body &&
    is_notifications_per_metric_dimension_enabled == other.is_notifications_per_metric_dimension_enabled &&
    message_format == other.message_format &&
    destinations == other.destinations &&
    repeat_notification_duration == other.repeat_notification_duration &&
    suppression == other.suppression &&
    is_enabled == other.is_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/oci/monitoring/models/alarm.rb', line 556

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


536
537
538
 
# File 'lib/oci/monitoring/models/alarm.rb', line 536

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



545
546
547
 
# File 'lib/oci/monitoring/models/alarm.rb', line 545

def hash
  [id, display_name, compartment_id, metric_compartment_id, metric_compartment_id_in_subtree, namespace, resource_group, query, resolution, pending_duration, severity, body, is_notifications_per_metric_dimension_enabled, message_format, destinations, repeat_notification_duration, suppression, is_enabled, freeform_tags, defined_tags, lifecycle_state, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



589
590
591
592
593
594
595
596
597
598
 
# File 'lib/oci/monitoring/models/alarm.rb', line 589

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



583
584
585
 
# File 'lib/oci/monitoring/models/alarm.rb', line 583

def to_s
  to_hash.to_s
end