Class: OCI::Monitoring::Models::AlarmHistoryEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/monitoring/models/alarm_history_entry.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlarmHistoryEntry

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :alarm_summary (String) —

    The value to assign to the #alarm_summary property

  • :summary (String) —

    The value to assign to the #summary property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property

  • :timestamp_triggered (DateTime) —

    The value to assign to the #timestamp_triggered property



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 81

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.alarm_summary = attributes[:'alarmSummary'] if attributes[:'alarmSummary']

  raise 'You cannot provide both :alarmSummary and :alarm_summary' if attributes.key?(:'alarmSummary') && attributes.key?(:'alarm_summary')

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

  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

Instance Attribute Details

#alarm_summary ⇒ String

[Required] Customizable alarm summary (alarmSummary alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to list_alarms_status get_alarm_history and retrieve_dimension_states.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 21

def alarm_summary
  @alarm_summary
end

#summary ⇒ String

[Required] Description for this alarm history entry.

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

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 30

def summary
  @summary
end

#timestamp ⇒ DateTime

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

Example: 2023-02-01T01:02:29.600Z

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 37

def timestamp
  @timestamp
end

#timestamp_triggered ⇒ DateTime

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: 2023-02-01T0:59:00.789Z

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 45

def timestamp_triggered
  @timestamp_triggered
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'alarm_summary': :'alarmSummary',
    'summary': :'summary',
    'timestamp': :'timestamp',
    'timestamp_triggered': :'timestampTriggered'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'alarm_summary': :'String',
    'summary': :'String',
    'timestamp': :'DateTime',
    'timestamp_triggered': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 111

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    alarm_summary == other.alarm_summary &&
    summary == other.summary &&
    timestamp == other.timestamp &&
    timestamp_triggered == other.timestamp_triggered
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 144

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


124
125
126
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 133

def hash
  [alarm_summary, summary, timestamp, timestamp_triggered].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 177

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

Returns:

  • (String) —

    String presentation of the object



171
172
173
 
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 171

def to_s
  to_hash.to_s
end