Class: OCI::Monitoring::Models::AlarmSuppression

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

Overview

The configuration details for an alarm suppression.

Constant Summary collapse

LEVEL_ENUM = 
[
  LEVEL_ALARM = 'ALARM'.freeze,
  LEVEL_DIMENSION = 'DIMENSION'.freeze,
  LEVEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlarmSuppression

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 191

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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_suppress_from = attributes[:'timeSuppressFrom'] if attributes[:'timeSuppressFrom']

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

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

  self.time_suppress_until = attributes[:'timeSuppressUntil'] if attributes[:'timeSuppressUntil']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

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

This attribute is required.

Returns:



35
36
37
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 35

def alarm_suppression_target
  @alarm_suppression_target
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the alarm suppression.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 31

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


122
123
124
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 122

def defined_tags
  @defined_tags
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) 


68
69
70
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 68

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


75
76
77
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 75

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) 


56
57
58
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 56

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


116
117
118
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 116

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the alarm suppression.

Returns:

  • (String) 


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

def id
  @id
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) 


42
43
44
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 42

def level
  @level
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the alarm suppression.

Example: DELETED

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 96

def lifecycle_state
  @lifecycle_state
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:



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

def suppression_conditions
  @suppression_conditions
end

#time_created ⇒ DateTime

[Required] The date and time the alarm suppression was created. Format defined by RFC3339.

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_suppress_from ⇒ DateTime

[Required] The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.

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

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 82

def time_suppress_from
  @time_suppress_from
end

#time_suppress_until ⇒ DateTime

[Required] The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.

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

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 89

def time_suppress_until
  @time_suppress_until
end

#time_updated ⇒ DateTime

[Required] The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339.

Example: 2018-02-03T01:02:29.600Z

Returns:

  • (DateTime) 


110
111
112
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 110

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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_suppression.rb', line 125

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'alarm_suppression_target': :'alarmSuppressionTarget',
    'level': :'level',
    'suppression_conditions': :'suppressionConditions',
    'display_name': :'displayName',
    'description': :'description',
    'dimensions': :'dimensions',
    'time_suppress_from': :'timeSuppressFrom',
    'time_suppress_until': :'timeSuppressUntil',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 148

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'alarm_suppression_target': :'OCI::Monitoring::Models::AlarmSuppressionTarget',
    'level': :'String',
    'suppression_conditions': :'Array<OCI::Monitoring::Models::SuppressionCondition>',
    'display_name': :'String',
    'description': :'String',
    'dimensions': :'Hash<String, String>',
    'time_suppress_from': :'DateTime',
    'time_suppress_until': :'DateTime',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 305

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    alarm_suppression_target == other.alarm_suppression_target &&
    level == other.level &&
    suppression_conditions == other.suppression_conditions &&
    display_name == other.display_name &&
    description == other.description &&
    dimensions == other.dimensions &&
    time_suppress_from == other.time_suppress_from &&
    time_suppress_until == other.time_suppress_until &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 349

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


329
330
331
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 329

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



338
339
340
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 338

def hash
  [id, compartment_id, alarm_suppression_target, level, suppression_conditions, display_name, description, dimensions, time_suppress_from, time_suppress_until, lifecycle_state, time_created, time_updated, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 382

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



376
377
378
 
# File 'lib/oci/monitoring/models/alarm_suppression.rb', line 376

def to_s
  to_hash.to_s
end