Class: OCI::Monitoring::Models::AlarmDimensionStatesEntry

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

Overview

A timestamped alarm state entry for a metric stream.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_FIRING = 'FIRING'.freeze,
  STATUS_OK = 'OK'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlarmDimensionStatesEntry

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

  • :dimensions (Hash<String, String>) —

    The value to assign to the #dimensions property

  • :status (String) —

    The value to assign to the #status property

  • :rule_name (String) —

    The value to assign to the #rule_name property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 91

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

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

  self.rule_name = attributes[:'ruleName'] if attributes[:'ruleName']

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

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

  self.timestamp = attributes[:'timestamp'] if attributes[:'timestamp']
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) 


27
28
29
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 27

def alarm_summary
  @alarm_summary
end

#dimensions ⇒ Hash<String, String>

[Required] Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs.

Returns:

  • (Hash<String, String>) 


32
33
34
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 32

def dimensions
  @dimensions
end

#rule_name ⇒ String

[Required] Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see alarm_override.

Returns:

  • (String) 


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

def rule_name
  @rule_name
end

#status ⇒ String

[Required] Transition state (status value) associated with the alarm state entry.

Example: FIRING

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 39

def status
  @status
end

#timestamp ⇒ DateTime

[Required] Transition time associated with the alarm state entry. Format defined by RFC3339.

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

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 52

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'alarm_summary': :'alarmSummary',
    'dimensions': :'dimensions',
    'status': :'status',
    'rule_name': :'ruleName',
    'timestamp': :'timestamp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'alarm_summary': :'String',
    'dimensions': :'Hash<String, String>',
    'status': :'String',
    'rule_name': :'String',
    'timestamp': :'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



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 136

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

  self.class == other.class &&
    alarm_summary == other.alarm_summary &&
    dimensions == other.dimensions &&
    status == other.status &&
    rule_name == other.rule_name &&
    timestamp == other.timestamp
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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 170

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 159

def hash
  [alarm_summary, dimensions, status, rule_name, timestamp].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 203

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



197
198
199
 
# File 'lib/oci/monitoring/models/alarm_dimension_states_entry.rb', line 197

def to_s
  to_hash.to_s
end