Class: OCI::Monitoring::Models::AlarmSummary

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

Overview

A summary of properties for the specified 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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlarmSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



290
291
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
330
331
332
333
334
335
336
337
338
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
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
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 290

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.namespace = attributes[:'namespace'] if attributes[:'namespace']

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

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

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

  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.is_notifications_per_metric_dimension_enabled = attributes[:'isNotificationsPerMetricDimensionEnabled'] unless attributes[:'isNotificationsPerMetricDimensionEnabled'].nil?

  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.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.overrides = attributes[:'overrides'] if attributes[:'overrides']

  self.rule_name = attributes[:'ruleName'] if attributes[:'ruleName']

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

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

  self.notification_version = attributes[:'notificationVersion'] if attributes[:'notificationVersion']

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

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

  self.notification_title = attributes[:'notificationTitle'] if attributes[:'notificationTitle']

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

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

  self.evaluation_slack_duration = attributes[:'evaluationSlackDuration'] if attributes[:'evaluationSlackDuration']

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

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

  self.alarm_summary = attributes[:'alarmSummary'] if attributes[:'alarmSummary']

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

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

  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']
end

Instance Attribute Details

#alarm_summary ⇒ String

Customizable alarm summary (alarmSummary alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to list_alarms_status get_alarm_history and retrieve_dimension_states.

Returns:

  • (String) 


195
196
197
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 195

def alarm_summary
  @alarm_summary
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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>>) 


141
142
143
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 141

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>) 


110
111
112
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 110

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) 


44
45
46
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 44

def display_name
  @display_name
end

#evaluation_slack_duration ⇒ String

Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.

Returns:

  • (String) 


185
186
187
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 185

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


135
136
137
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 135

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the alarm.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 35

def id
  @id
end

#is_enabled ⇒ BOOLEAN

[Required] Whether the alarm is enabled.

Example: true

Returns:

  • (BOOLEAN) 


122
123
124
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 122

def is_enabled
  @is_enabled
end

#is_notifications_per_metric_dimension_enabled ⇒ BOOLEAN

Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

Returns:

  • (BOOLEAN) 


129
130
131
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 129

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) 


148
149
150
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 148

def lifecycle_state
  @lifecycle_state
end

#metric_compartment_id ⇒ String

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

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 55

def metric_compartment_id
  @metric_compartment_id
end

#namespace ⇒ String

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

Example: oci_computeagent

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 62

def namespace
  @namespace
end

#notification_title ⇒ String

Customizable notification title (title alarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.

Returns:

  • (String) 


176
177
178
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 176

def notification_title
  @notification_title
end

#notification_version ⇒ String

The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

Returns:

  • (String) 


169
170
171
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 169

def notification_version
  @notification_version
end

#overrides ⇒ Array<OCI::Monitoring::Models::AlarmOverride>

A set of overrides that control evaluations of the alarm.

Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position 0), and then evaluates the alarm's base values (ruleName value of BASE).

Returns:



157
158
159
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 157

def overrides
  @overrides
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. 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) 


94
95
96
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 94

def query
  @query
end

#resource_group ⇒ String

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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) 


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

def resource_group
  @resource_group
end

#rule_name ⇒ String

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see alarm_override.

Returns:

  • (String) 


163
164
165
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 163

def rule_name
  @rule_name
end

#severity ⇒ String

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

Example: CRITICAL

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 101

def severity
  @severity
end

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

The configuration details for suppressing an alarm.

Returns:



115
116
117
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 115

def suppression
  @suppression
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'metric_compartment_id': :'metricCompartmentId',
    'namespace': :'namespace',
    'query': :'query',
    'severity': :'severity',
    'destinations': :'destinations',
    'suppression': :'suppression',
    'is_enabled': :'isEnabled',
    'is_notifications_per_metric_dimension_enabled': :'isNotificationsPerMetricDimensionEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_state': :'lifecycleState',
    'overrides': :'overrides',
    'rule_name': :'ruleName',
    'notification_version': :'notificationVersion',
    'notification_title': :'notificationTitle',
    'evaluation_slack_duration': :'evaluationSlackDuration',
    'alarm_summary': :'alarmSummary',
    'resource_group': :'resourceGroup'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'metric_compartment_id': :'String',
    'namespace': :'String',
    'query': :'String',
    'severity': :'String',
    'destinations': :'Array<String>',
    'suppression': :'OCI::Monitoring::Models::Suppression',
    'is_enabled': :'BOOLEAN',
    'is_notifications_per_metric_dimension_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'overrides': :'Array<OCI::Monitoring::Models::AlarmOverride>',
    'rule_name': :'String',
    'notification_version': :'String',
    'notification_title': :'String',
    'evaluation_slack_duration': :'String',
    'alarm_summary': :'String',
    'resource_group': :'String'
    # 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



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

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 &&
    namespace == other.namespace &&
    query == other.query &&
    severity == other.severity &&
    destinations == other.destinations &&
    suppression == other.suppression &&
    is_enabled == other.is_enabled &&
    is_notifications_per_metric_dimension_enabled == other.is_notifications_per_metric_dimension_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_state == other.lifecycle_state &&
    overrides == other.overrides &&
    rule_name == other.rule_name &&
    notification_version == other.notification_version &&
    notification_title == other.notification_title &&
    evaluation_slack_duration == other.evaluation_slack_duration &&
    alarm_summary == other.alarm_summary &&
    resource_group == other.resource_group
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



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 465

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


445
446
447
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 445

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



454
455
456
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 454

def hash
  [id, display_name, compartment_id, metric_compartment_id, namespace, query, severity, destinations, suppression, is_enabled, is_notifications_per_metric_dimension_enabled, freeform_tags, defined_tags, lifecycle_state, overrides, rule_name, notification_version, notification_title, evaluation_slack_duration, alarm_summary, resource_group].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



498
499
500
501
502
503
504
505
506
507
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 498

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



492
493
494
 
# File 'lib/oci/monitoring/models/alarm_summary.rb', line 492

def to_s
  to_hash.to_s
end