class OCI::Monitoring::Models::AlarmStatusSummary
A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see [Alarms Overview](docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview).
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](docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
For information about endpoints and signing API requests, see [About the API](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](docs.cloud.oracle.com/iaas/Content/API/Concepts/sdks.htm).
Constants
- SEVERITY_ENUM
- STATUS_ENUM
Attributes
[Required] The configured name of the alarm.
Example: `High CPU Utilization`
@return [String]
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
@return [String]
[Required] The configured severity of the alarm.
Example: `CRITICAL`
@return [String]
[Required] The status of this alarm.
Example: `FIRING`
@return [String]
The configuration details for suppressing an alarm.
@return [OCI::Monitoring::Models::Suppression]
[Required] Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing.
Example: `2019-02-01T01:02:29.600Z`
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/monitoring/models/alarm_status_summary.rb, line 75 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'severity': :'severity', 'timestamp_triggered': :'timestampTriggered', 'status': :'status', 'suppression': :'suppression' # 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] :display_name The value to assign to the {#display_name} property @option attributes [String] :severity The value to assign to the {#severity} property @option attributes [DateTime] :timestamp_triggered The value to assign to the {#timestamp_triggered} property @option attributes [String] :status The value to assign to the {#status} property @option attributes [OCI::Monitoring::Models::Suppression] :suppression The value to assign to the {#suppression} property
# File lib/oci/monitoring/models/alarm_status_summary.rb, line 114 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.timestamp_triggered = attributes[:'timestampTriggered'] if attributes[:'timestampTriggered'] raise 'You cannot provide both :timestampTriggered and :timestamp_triggered' if attributes.key?(:'timestampTriggered') && attributes.key?(:'timestamp_triggered') self.timestamp_triggered = attributes[:'timestamp_triggered'] if attributes[:'timestamp_triggered'] self.status = attributes[:'status'] if attributes[:'status'] self.suppression = attributes[:'suppression'] if attributes[:'suppression'] end
Attribute type mapping.
# File lib/oci/monitoring/models/alarm_status_summary.rb, line 89 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'severity': :'String', 'timestamp_triggered': :'DateTime', 'status': :'String', 'suppression': :'OCI::Monitoring::Models::Suppression' # 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/monitoring/models/alarm_status_summary.rb, line 174 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && severity == other.severity && timestamp_triggered == other.timestamp_triggered && status == other.status && suppression == other.suppression 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/monitoring/models/alarm_status_summary.rb, line 209 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/monitoring/models/alarm_status_summary.rb, line 189 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/monitoring/models/alarm_status_summary.rb, line 198 def hash [id, display_name, severity, timestamp_triggered, status, suppression].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] severity Object
to be assigned
# File lib/oci/monitoring/models/alarm_status_summary.rb, line 145 def severity=(severity) # rubocop:disable Style/ConditionalAssignment if severity && !SEVERITY_ENUM.include?(severity) OCI.logger.debug("Unknown value for 'severity' [" + severity + "]. Mapping to 'SEVERITY_UNKNOWN_ENUM_VALUE'") if OCI.logger @severity = SEVERITY_UNKNOWN_ENUM_VALUE else @severity = severity end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object
to be assigned
# File lib/oci/monitoring/models/alarm_status_summary.rb, line 158 def status=(status) # rubocop:disable Style/ConditionalAssignment if status && !STATUS_ENUM.include?(status) OCI.logger.debug("Unknown value for 'status' [" + status + "]. Mapping to 'STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger @status = STATUS_UNKNOWN_ENUM_VALUE else @status = status 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/monitoring/models/alarm_status_summary.rb, line 242 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/monitoring/models/alarm_status_summary.rb, line 236 def to_s to_hash.to_s 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/monitoring/models/alarm_status_summary.rb, line 259 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