class OCI::Monitoring::Models::Suppression
The configuration details for suppressing an alarm. For information about alarms, see [Alarms Overview](docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview).
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Attributes
Human-readable reason for suppressing alarm notifications. 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.`
@return [String]
[Required] The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: `2019-02-01T01:02:29.600Z`
@return [DateTime]
[Required] The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: `2019-02-01T02:02:29.600Z`
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/monitoring/models/suppression.rb, line 42 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'description': :'description', 'time_suppress_from': :'timeSuppressFrom', 'time_suppress_until': :'timeSuppressUntil' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :description The value to assign to the {#description} property @option attributes [DateTime] :time_suppress_from The value to assign to the {#time_suppress_from} property @option attributes [DateTime] :time_suppress_until The value to assign to the {#time_suppress_until} property
# File lib/oci/monitoring/models/suppression.rb, line 72 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.description = attributes[:'description'] if attributes[:'description'] 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'] end
Attribute type mapping.
# File lib/oci/monitoring/models/suppression.rb, line 53 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'description': :'String', 'time_suppress_from': :'DateTime', 'time_suppress_until': :'DateTime' # 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/suppression.rb, line 100 def ==(other) return true if equal?(other) self.class == other.class && description == other.description && time_suppress_from == other.time_suppress_from && time_suppress_until == other.time_suppress_until 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/suppression.rb, line 132 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/suppression.rb, line 112 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/monitoring/models/suppression.rb, line 121 def hash [description, time_suppress_from, time_suppress_until].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/monitoring/models/suppression.rb, line 165 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/suppression.rb, line 159 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/suppression.rb, line 182 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