Class: OCI::Monitoring::Models::CreateAlarmSuppressionDetails
- Inherits:
-
Object
- Object
- OCI::Monitoring::Models::CreateAlarmSuppressionDetails
- Defined in:
- lib/oci/monitoring/models/create_alarm_suppression_details.rb
Overview
The configuration details for creating a dimension-specific alarm suppression.
Instance Attribute Summary collapse
-
#alarm_suppression_target ⇒ OCI::Monitoring::Models::AlarmSuppressionTarget
This attribute is required.
-
#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] A filter to suppress only 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.
-
#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.
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 = {}) ⇒ CreateAlarmSuppressionDetails
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 = {}) ⇒ CreateAlarmSuppressionDetails
Initializes the object
117 118 119 120 121 122 123 124 125 126 127 128 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 161 162 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 117 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.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. = 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.
14 15 16 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 14 def alarm_suppression_target @alarm_suppression_target end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
69 70 71 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 69 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.
30 31 32 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 30 def description @description end |
#dimensions ⇒ Hash<String, String>
[Required] A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify "phx-ad-1" and the alarm state entry corresponds to the set "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID", then this alarm will be included for suppression.
The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400
with an "dimensions values are too long" message.
43 44 45 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 43 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.
18 19 20 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 18 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\"}
63 64 65 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 63 def @freeform_tags end |
#time_suppress_from ⇒ DateTime
[Required] The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: 2023-02-01T01:02:29.600Z
50 51 52 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 50 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: 2023-02-01T02:02:29.600Z
57 58 59 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 57 def time_suppress_until @time_suppress_until end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 72 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'alarm_suppression_target': :'alarmSuppressionTarget', 'display_name': :'displayName', 'description': :'description', 'dimensions': :'dimensions', 'time_suppress_from': :'timeSuppressFrom', 'time_suppress_until': :'timeSuppressUntil', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 88 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'alarm_suppression_target': :'OCI::Monitoring::Models::AlarmSuppressionTarget', 'display_name': :'String', 'description': :'String', 'dimensions': :'Hash<String, String>', 'time_suppress_from': :'DateTime', 'time_suppress_until': :'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.
171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 171 def ==(other) return true if equal?(other) self.class == other.class && 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 && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 208 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
188 189 190 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 188 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
197 198 199 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 197 def hash [alarm_suppression_target, display_name, description, dimensions, time_suppress_from, time_suppress_until, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
241 242 243 244 245 246 247 248 249 250 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 241 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
235 236 237 |
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 235 def to_s to_hash.to_s end |