Class: OCI::Monitoring::Models::AlarmSuppression
- Inherits:
-
Object
- Object
- OCI::Monitoring::Models::AlarmSuppression
- Defined in:
- lib/oci/monitoring/models/alarm_suppression.rb
Overview
The configuration details for a dimension-specific alarm suppression.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#alarm_suppression_target ⇒ OCI::Monitoring::Models::AlarmSuppressionTarget
This attribute is required.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the alarm suppression.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys.
-
#description ⇒ String
Human-readable reason for this alarm suppression.
-
#dimensions ⇒ Hash<String, String>
[Required] Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.
-
#display_name ⇒ String
[Required] A user-friendly name for the alarm suppression.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the alarm suppression.
-
#lifecycle_state ⇒ String
[Required] The current lifecycle state of the alarm suppression.
-
#time_created ⇒ DateTime
[Required] The date and time the alarm suppression was created.
-
#time_suppress_from ⇒ DateTime
[Required] The start date and time for the suppression to take place, inclusive.
-
#time_suppress_until ⇒ DateTime
[Required] The end date and time for the suppression to take place, inclusive.
-
#time_updated ⇒ DateTime
[Required] The date and time the alarm suppression was last updated (deleted).
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 = {}) ⇒ AlarmSuppression
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 = {}) ⇒ AlarmSuppression
Initializes the object
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 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 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 162 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.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.alarm_suppression_target = attributes[:'alarmSuppressionTarget'] if attributes[:'alarmSuppressionTarget'] raise 'You cannot provide both :alarmSuppressionTarget and :alarm_suppression_target' if attributes.key?(:'alarmSuppressionTarget') && attributes.key?(:'alarm_suppression_target') self.alarm_suppression_target = attributes[:'alarm_suppression_target'] if attributes[:'alarm_suppression_target'] 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.description = attributes[:'description'] if attributes[:'description'] self.dimensions = attributes[:'dimensions'] if attributes[:'dimensions'] self.time_suppress_from = attributes[:'timeSuppressFrom'] if attributes[:'timeSuppressFrom'] raise 'You cannot provide both :timeSuppressFrom and :time_suppress_from' if attributes.key?(:'timeSuppressFrom') && attributes.key?(:'time_suppress_from') self.time_suppress_from = attributes[:'time_suppress_from'] if attributes[:'time_suppress_from'] self.time_suppress_until = attributes[:'timeSuppressUntil'] if attributes[:'timeSuppressUntil'] raise 'You cannot provide both :timeSuppressUntil and :time_suppress_until' if attributes.key?(:'timeSuppressUntil') && attributes.key?(:'time_suppress_until') self.time_suppress_until = attributes[:'time_suppress_until'] if attributes[:'time_suppress_until'] 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'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#alarm_suppression_target ⇒ OCI::Monitoring::Models::AlarmSuppressionTarget
This attribute is required.
29 30 31 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 29 def alarm_suppression_target @alarm_suppression_target end |
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the alarm suppression.
25 26 27 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 25 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\"}}
99 100 101 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 99 def @defined_tags end |
#description ⇒ String
Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
Oracle recommends including tracking information for the event or associated work, such as a ticket number.
Example: Planned outage due to change IT-1234.
45 46 47 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 45 def description @description end |
#dimensions ⇒ Hash<String, String>
[Required] Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.
Example: {\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"}
52 53 54 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 52 def dimensions @dimensions end |
#display_name ⇒ String
[Required] A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
33 34 35 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 33 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\"}
93 94 95 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 93 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the alarm suppression.
21 22 23 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 21 def id @id end |
#lifecycle_state ⇒ String
[Required] The current lifecycle state of the alarm suppression.
Example: DELETED
73 74 75 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 73 def lifecycle_state @lifecycle_state end |
#time_created ⇒ DateTime
[Required] The date and time the alarm suppression was created. Format defined by RFC3339.
Example: 2018-02-01T01:02:29.600Z
80 81 82 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 80 def time_created @time_created end |
#time_suppress_from ⇒ DateTime
[Required] The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: 2018-02-01T01:02:29.600Z
59 60 61 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 59 def time_suppress_from @time_suppress_from end |
#time_suppress_until ⇒ DateTime
[Required] The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: 2018-02-01T02:02:29.600Z
66 67 68 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 66 def time_suppress_until @time_suppress_until end |
#time_updated ⇒ DateTime
[Required] The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339.
Example: 2018-02-03T01:02:29.600Z
87 88 89 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 87 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 102 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'alarm_suppression_target': :'alarmSuppressionTarget', 'display_name': :'displayName', 'description': :'description', 'dimensions': :'dimensions', 'time_suppress_from': :'timeSuppressFrom', 'time_suppress_until': :'timeSuppressUntil', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 123 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'alarm_suppression_target': :'OCI::Monitoring::Models::AlarmSuppressionTarget', 'display_name': :'String', 'description': :'String', 'dimensions': :'Hash<String, String>', 'time_suppress_from': :'DateTime', 'time_suppress_until': :'DateTime', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 255 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && alarm_suppression_target == other.alarm_suppression_target && display_name == other.display_name && description == other.description && dimensions == other.dimensions && time_suppress_from == other.time_suppress_from && time_suppress_until == other.time_suppress_until && lifecycle_state == other.lifecycle_state && time_created == other.time_created && time_updated == other.time_updated && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 297 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
277 278 279 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 277 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
286 287 288 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 286 def hash [id, compartment_id, alarm_suppression_target, display_name, description, dimensions, time_suppress_from, time_suppress_until, lifecycle_state, time_created, time_updated, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
330 331 332 333 334 335 336 337 338 339 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 330 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
324 325 326 |
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 324 def to_s to_hash.to_s end |