Class: OCI::Budget::Models::AlertRuleSummary
- Inherits:
-
Object
- Object
- OCI::Budget::Models::AlertRuleSummary
- Defined in:
- lib/oci/budget/models/alert_rule_summary.rb
Overview
The alert rule.
Constant Summary collapse
- TYPE_ENUM =
[ TYPE_ACTUAL = 'ACTUAL'.freeze, TYPE_FORECAST = 'FORECAST'.freeze, TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- THRESHOLD_TYPE_ENUM =
[ THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'.freeze, THRESHOLD_TYPE_ABSOLUTE = 'ABSOLUTE'.freeze, THRESHOLD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#budget_id ⇒ String
[Required] The OCID of the budget.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the alert rule.
-
#display_name ⇒ String
[Required] The name of the alert rule.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the alert rule.
-
#lifecycle_state ⇒ String
[Required] The current state of the alert rule.
-
#message ⇒ String
The custom message that will be sent when the alert is triggered.
-
#recipients ⇒ String
[Required] The audience that receives the alert when it triggers.
-
#threshold ⇒ Float
[Required] The threshold for triggering the alert.
-
#threshold_type ⇒ String
[Required] The type of threshold.
-
#time_created ⇒ DateTime
[Required] The time when the budget was created.
-
#time_updated ⇒ DateTime
[Required] The time when the budget was updated.
-
#type ⇒ String
[Required] ACTUAL means the alert triggers based on actual usage.
-
#version ⇒ Integer
The version of the alert rule.
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 = {}) ⇒ AlertRuleSummary
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 = {}) ⇒ AlertRuleSummary
Initializes the object
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 234 235 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 168 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.budget_id = attributes[:'budgetId'] if attributes[:'budgetId'] raise 'You cannot provide both :budgetId and :budget_id' if attributes.key?(:'budgetId') && attributes.key?(:'budget_id') self.budget_id = attributes[:'budget_id'] if attributes[:'budget_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.type = attributes[:'type'] if attributes[:'type'] self.threshold = attributes[:'threshold'] if attributes[:'threshold'] self.threshold_type = attributes[:'thresholdType'] if attributes[:'thresholdType'] raise 'You cannot provide both :thresholdType and :threshold_type' if attributes.key?(:'thresholdType') && attributes.key?(:'threshold_type') self.threshold_type = attributes[:'threshold_type'] if attributes[:'threshold_type'] 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. = attributes[:'message'] if attributes[:'message'] self.description = attributes[:'description'] if attributes[:'description'] self.version = attributes[:'version'] if attributes[:'version'] self.recipients = attributes[:'recipients'] if attributes[:'recipients'] 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
#budget_id ⇒ String
[Required] The OCID of the budget.
36 37 38 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 36 def budget_id @budget_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
99 100 101 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 99 def @defined_tags end |
#description ⇒ String
The description of the alert rule.
67 68 69 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 67 def description @description end |
#display_name ⇒ String
[Required] The name of the alert rule. Avoid entering confidential information.
40 41 42 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 40 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {\"Department\": \"Finance\"}
91 92 93 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 91 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the alert rule.
32 33 34 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 32 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the alert rule.
59 60 61 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 59 def lifecycle_state @lifecycle_state end |
#message ⇒ String
The custom message that will be sent when the alert is triggered.
63 64 65 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 63 def @message end |
#recipients ⇒ String
[Required] The audience that receives the alert when it triggers.
75 76 77 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 75 def recipients @recipients end |
#threshold ⇒ Float
[Required] The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
51 52 53 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 51 def threshold @threshold end |
#threshold_type ⇒ String
[Required] The type of threshold.
55 56 57 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 55 def threshold_type @threshold_type end |
#time_created ⇒ DateTime
[Required] The time when the budget was created.
79 80 81 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 79 def time_created @time_created end |
#time_updated ⇒ DateTime
[Required] The time when the budget was updated.
83 84 85 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 83 def time_updated @time_updated end |
#type ⇒ String
[Required] ACTUAL means the alert triggers based on actual usage. FORECAST means the alert triggers based on predicted usage.
46 47 48 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 46 def type @type end |
#version ⇒ Integer
The version of the alert rule. Starts from 1 and increments by 1.
71 72 73 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 71 def version @version 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 121 122 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 102 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'budget_id': :'budgetId', 'display_name': :'displayName', 'type': :'type', 'threshold': :'threshold', 'threshold_type': :'thresholdType', 'lifecycle_state': :'lifecycleState', 'message': :'message', 'description': :'description', 'version': :'version', 'recipients': :'recipients', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 125 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'budget_id': :'String', 'display_name': :'String', 'type': :'String', 'threshold': :'Float', 'threshold_type': :'String', 'lifecycle_state': :'String', 'message': :'String', 'description': :'String', 'version': :'Integer', 'recipients': :'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.
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 283 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && budget_id == other.budget_id && display_name == other.display_name && type == other.type && threshold == other.threshold && threshold_type == other.threshold_type && lifecycle_state == other.lifecycle_state && == other. && description == other.description && version == other.version && recipients == other.recipients && time_created == other.time_created && time_updated == other.time_updated && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 327 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
307 308 309 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 307 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
316 317 318 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 316 def hash [id, budget_id, display_name, type, threshold, threshold_type, lifecycle_state, , description, version, recipients, time_created, time_updated, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
360 361 362 363 364 365 366 367 368 369 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 360 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
354 355 356 |
# File 'lib/oci/budget/models/alert_rule_summary.rb', line 354 def to_s to_hash.to_s end |