class OCI::Budget::Models::AlertRuleSummary
The alert rule.
Constants
- LIFECYCLE_STATE_ENUM
- THRESHOLD_TYPE_ENUM
- TYPE_ENUM
Attributes
[Required] The OCID of the budget @return [String]
The description of the alert rule. @return [String]
[Required] The name of the alert rule. @return [String]
[Required] The OCID of the alert rule @return [String]
[Required] The current state of the alert rule. @return [String]
Custom message that will be sent when alert is triggered @return [String]
[Required] The audience that will receive the alert when it triggers. @return [String]
[Required] The threshold for triggering the alert. If thresholdType is PERCENTAGE, the maximum value is 10000.
@return [Float]
[Required] The type of threshold. @return [String]
[Required] Time when budget was created @return [DateTime]
[Required] Time when budget was updated @return [DateTime]
[Required] ACTUAL means the alert will trigger based on actual usage. FORECAST means the alert will trigger based on predicted usage.
@return [String]
Version of the alert rule. Starts from 1 and increments by 1. @return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/budget/models/alert_rule_summary.rb, line 101 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :budget_id The value to assign to the {#budget_id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :type The value to assign to the {#type} property @option attributes [Float] :threshold The value to assign to the {#threshold} property @option attributes [String] :threshold_type The value to assign to the {#threshold_type} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :message The value to assign to the {#message} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [Integer] :version The value to assign to the {#version} property @option attributes [String] :recipients The value to assign to the {#recipients} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
# File lib/oci/budget/models/alert_rule_summary.rb, line 167 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.message = 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.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'] end
Attribute type mapping.
# File lib/oci/budget/models/alert_rule_summary.rb, line 124 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/budget/models/alert_rule_summary.rb, line 282 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 && message == other.message && description == other.description && version == other.version && recipients == other.recipients && time_created == other.time_created && time_updated == other.time_updated && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/budget/models/alert_rule_summary.rb, line 326 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/budget/models/alert_rule_summary.rb, line 306 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/budget/models/alert_rule_summary.rb, line 315 def hash [id, budget_id, display_name, type, threshold, threshold_type, lifecycle_state, message, description, version, recipients, time_created, time_updated, freeform_tags, defined_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/budget/models/alert_rule_summary.rb, line 266 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] threshold_type
Object
to be assigned
# File lib/oci/budget/models/alert_rule_summary.rb, line 253 def threshold_type=(threshold_type) # rubocop:disable Style/ConditionalAssignment if threshold_type && !THRESHOLD_TYPE_ENUM.include?(threshold_type) OCI.logger.debug("Unknown value for 'threshold_type' [" + threshold_type + "]. Mapping to 'THRESHOLD_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @threshold_type = THRESHOLD_TYPE_UNKNOWN_ENUM_VALUE else @threshold_type = threshold_type end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/budget/models/alert_rule_summary.rb, line 359 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/budget/models/alert_rule_summary.rb, line 353 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object
to be assigned
# File lib/oci/budget/models/alert_rule_summary.rb, line 240 def type=(type) # rubocop:disable Style/ConditionalAssignment if type && !TYPE_ENUM.include?(type) OCI.logger.debug("Unknown value for 'type' [" + type + "]. Mapping to 'TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @type = TYPE_UNKNOWN_ENUM_VALUE else @type = type end # rubocop:enable Style/ConditionalAssignment end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/budget/models/alert_rule_summary.rb, line 376 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end