Class: OCI::Monitoring::Models::AlarmStatusSummary
- Inherits:
-
Object
- Object
- OCI::Monitoring::Models::AlarmStatusSummary
- Defined in:
- lib/oci/monitoring/models/alarm_status_summary.rb
Overview
A summary of properties for the specified alarm and its current evaluation status. 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
- STATUS_ENUM =
[ STATUS_FIRING = 'FIRING'.freeze, STATUS_OK = 'OK'.freeze, STATUS_SUSPENDED = 'SUSPENDED'.freeze, STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#display_name ⇒ String
[Required] The configured name of the alarm.
-
#id ⇒ String
[Required] The OCID of the alarm.
-
#rule_name ⇒ String
[Required] Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
-
#severity ⇒ String
[Required] The perceived type of response required when the alarm is in the "FIRING" state.
-
#status ⇒ String
[Required] The status of this alarm.
-
#suppression ⇒ OCI::Monitoring::Models::Suppression
The configuration details for suppressing an alarm.
-
#timestamp_triggered ⇒ DateTime
[Required] Timestamp for the transition of the alarm state.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ AlarmStatusSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ AlarmStatusSummary
Initializes the object
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 129 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.severity = attributes[:'severity'] if attributes[:'severity'] 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. = attributes[:'timestampTriggered'] if attributes[:'timestampTriggered'] raise 'You cannot provide both :timestampTriggered and :timestamp_triggered' if attributes.key?(:'timestampTriggered') && attributes.key?(:'timestamp_triggered') self. = attributes[:'timestamp_triggered'] if attributes[:'timestamp_triggered'] self.status = attributes[:'status'] if attributes[:'status'] self.suppression = attributes[:'suppression'] if attributes[:'suppression'] end |
Instance Attribute Details
#display_name ⇒ String
[Required] The configured name of the alarm.
Example: High CPU Utilization
49 50 51 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 49 def display_name @display_name end |
#id ⇒ String
[Required] The OCID of the alarm.
42 43 44 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 42 def id @id end |
#rule_name ⇒ String
[Required] Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is BASE
. For information about alarm overrides, see alarm_override.
63 64 65 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 63 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
56 57 58 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 56 def severity @severity end |
#status ⇒ String
[Required] The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use retrieve_dimension_states. Example: FIRING
79 80 81 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 79 def status @status end |
#suppression ⇒ OCI::Monitoring::Models::Suppression
The configuration details for suppressing an alarm.
84 85 86 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 84 def suppression @suppression end |
#timestamp_triggered ⇒ DateTime
[Required] Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics.
Example: 2023-02-01T01:02:29.600Z
71 72 73 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 71 def @timestamp_triggered end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 87 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'severity': :'severity', 'rule_name': :'ruleName', 'timestamp_triggered': :'timestampTriggered', 'status': :'status', 'suppression': :'suppression' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 102 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'severity': :'String', 'rule_name': :'String', 'timestamp_triggered': :'DateTime', 'status': :'String', 'suppression': :'OCI::Monitoring::Models::Suppression' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 195 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && severity == other.severity && rule_name == other.rule_name && == other. && status == other.status && suppression == other.suppression end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 231 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
211 212 213 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 211 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
220 221 222 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 220 def hash [id, display_name, severity, rule_name, , status, suppression].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
264 265 266 267 268 269 270 271 272 273 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 264 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
258 259 260 |
# File 'lib/oci/monitoring/models/alarm_status_summary.rb', line 258 def to_s to_hash.to_s end |