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):

  • :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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# 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

Instance Attribute Details

#summaryString

[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

Returns:

  • (String)


19
20
21
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 19

def summary
  @summary
end

#timestampDateTime

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

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

Returns:

  • (DateTime)


26
27
28
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 26

def timestamp
  @timestamp
end

#timestamp_triggeredDateTime

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

Returns:

  • (DateTime)


34
35
36
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 34

def timestamp_triggered
  @timestamp_triggered
end

Class Method Details

.attribute_mapObject

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



37
38
39
40
41
42
43
44
45
# 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

.swagger_typesObject

Attribute type mapping.



48
49
50
51
52
53
54
55
56
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



91
92
93
94
95
96
97
98
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# 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) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


103
104
105
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 103

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



112
113
114
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 112

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



150
151
152
# File 'lib/oci/monitoring/models/alarm_history_entry.rb', line 150

def to_s
  to_hash.to_s
end