Class: OCI::Monitoring::Models::AlarmSuppressionHistoryItem

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

Overview

A summary of properties for the specified alarm suppression history item.

Constant Summary collapse

LEVEL_ENUM = 
[
  LEVEL_ALARM = 'ALARM'.freeze,
  LEVEL_DIMENSION = 'DIMENSION'.freeze,
  LEVEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlarmSuppressionHistoryItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 130

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

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

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

  self.alarm_suppression_target = attributes[:'alarmSuppressionTarget'] if attributes[:'alarmSuppressionTarget']

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

  self.time_effective_from = attributes[:'timeEffectiveFrom'] if attributes[:'timeEffectiveFrom']

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

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

  self.time_effective_until = attributes[:'timeEffectiveUntil'] if attributes[:'timeEffectiveUntil']

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

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

  self.suppression_conditions = attributes[:'suppressionConditions'] if attributes[:'suppressionConditions']

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

  self.suppression_conditions = attributes[:'suppression_conditions'] if attributes[:'suppression_conditions']
end

Instance Attribute Details

#alarm_suppression_target ⇒ OCI::Monitoring::Models::AlarmSuppressionTarget

This attribute is required.

Returns:



25
26
27
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 25

def alarm_suppression_target
  @alarm_suppression_target
end

#description ⇒ String

Human-readable reason for this alarm suppression. 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.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 48

def description
  @description
end

#dimensions ⇒ Hash<String, String>

Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.

Example: {\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"}

Returns:

  • (Hash<String, String>) 


55
56
57
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 55

def dimensions
  @dimensions
end

#display_name ⇒ String

[Required] A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 36

def display_name
  @display_name
end

#level ⇒ String

[Required] The level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions.

Returns:

  • (String) 


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

def level
  @level
end

#suppression_conditions ⇒ Array<OCI::Monitoring::Models::SuppressionCondition>

Array of all preconditions for alarm suppression. Example: [{ conditionType: \"RECURRENCE\", suppressionRecurrence: \"FRQ=DAILY;BYHOUR=10\", suppressionDuration: \"PT1H\" }]

Returns:



79
80
81
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 79

def suppression_conditions
  @suppression_conditions
end

#suppression_id ⇒ String

[Required] The OCID of the alarm suppression.

Returns:

  • (String) 


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

def suppression_id
  @suppression_id
end

#time_effective_from ⇒ DateTime

[Required] The start date and time for the suppression actually starts, inclusive. Format defined by RFC3339.

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

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 62

def time_effective_from
  @time_effective_from
end

#time_effective_until ⇒ DateTime

[Required] The end date and time for the suppression actually ends, inclusive. Format defined by RFC3339.

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

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 69

def time_effective_until
  @time_effective_until
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 82

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'suppression_id': :'suppressionId',
    'alarm_suppression_target': :'alarmSuppressionTarget',
    'level': :'level',
    'display_name': :'displayName',
    'description': :'description',
    'dimensions': :'dimensions',
    'time_effective_from': :'timeEffectiveFrom',
    'time_effective_until': :'timeEffectiveUntil',
    'suppression_conditions': :'suppressionConditions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 99

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'suppression_id': :'String',
    'alarm_suppression_target': :'OCI::Monitoring::Models::AlarmSuppressionTarget',
    'level': :'String',
    'display_name': :'String',
    'description': :'String',
    'dimensions': :'Hash<String, String>',
    'time_effective_from': :'DateTime',
    'time_effective_until': :'DateTime',
    'suppression_conditions': :'Array<OCI::Monitoring::Models::SuppressionCondition>'
    # 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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 199

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

  self.class == other.class &&
    suppression_id == other.suppression_id &&
    alarm_suppression_target == other.alarm_suppression_target &&
    level == other.level &&
    display_name == other.display_name &&
    description == other.description &&
    dimensions == other.dimensions &&
    time_effective_from == other.time_effective_from &&
    time_effective_until == other.time_effective_until &&
    suppression_conditions == other.suppression_conditions
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 237

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


217
218
219
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 217

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 226

def hash
  [suppression_id, alarm_suppression_target, level, display_name, description, dimensions, time_effective_from, time_effective_until, suppression_conditions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 270

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



264
265
266
 
# File 'lib/oci/monitoring/models/alarm_suppression_history_item.rb', line 264

def to_s
  to_hash.to_s
end