class OCI::Monitoring::Models::AlarmHistoryEntry

An alarm history entry indicating a description of the entry and the time that the entry occurred. If the entry corresponds to a state transition, such as OK to Firing, then the entry also includes a transition timestamp.

Attributes

summary[RW]

[Required] Description for this alarm history entry. Avoid entering confidential information.

Example 1 - alarm state history entry: `The alarm state is FIRING`

Example 2 - alarm state transition history entry: `State transitioned from OK to Firing`

@return [String]

timestamp[RW]

[Required] Timestamp for this alarm history entry. Format defined by RFC3339.

Example: `2019-02-01T01:02:29.600Z`

@return [DateTime]

timestamp_triggered[RW]

Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics.

Example: `2019-02-01T0:59:00.789Z`

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 37
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'summary': :'summary',
    'timestamp': :'timestamp',
    'timestamp_triggered': :'timestampTriggered'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :summary The value to assign to the {#summary} property @option attributes [DateTime] :timestamp The value to assign to the {#timestamp} property @option attributes [DateTime] :timestamp_triggered The value to assign to the {#timestamp_triggered} property

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 67
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.summary = attributes[:'summary'] if attributes[:'summary']

  self.timestamp = attributes[:'timestamp'] if attributes[:'timestamp']

  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']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 48
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'summary': :'String',
    'timestamp': :'DateTime',
    'timestamp_triggered': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 91
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    summary == other.summary &&
    timestamp == other.timestamp &&
    timestamp_triggered == other.timestamp_triggered
end
build_from_hash(attributes) click to toggle source

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_history_entry.rb, line 123
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 103
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 112
def hash
  [summary, timestamp, timestamp_triggered].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 156
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/monitoring/models/alarm_history_entry.rb, line 150
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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_history_entry.rb, line 173
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