Class: OCI::Monitoring::Models::CreateAlarmSuppressionDetails

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

Overview

The configuration details for creating an alarm suppression.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAlarmSuppressionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 142

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_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_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.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']

  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:



14
15
16
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 14

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


78
79
80
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 78

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) 


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

def description
  @description
end

#dimensions ⇒ Hash<String, String>

A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify "phx-ad-1" and the alarm state entry corresponds to the set "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID", then this alarm will be included for suppression.

This is required only when the value of level is DIMENSION. If required, the value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

Returns:

  • (Hash<String, String>) 


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

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) 


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

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


72
73
74
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 72

def freeform_tags
  @freeform_tags
end

#level ⇒ String

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.

Defaut: DIMENSION

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 23

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:



88
89
90
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 88

def suppression_conditions
  @suppression_conditions
end

#time_suppress_from ⇒ DateTime

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

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

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 59

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: 2023-02-01T02:02:29.600Z

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 66

def time_suppress_until
  @time_suppress_until
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 91

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'alarm_suppression_target': :'alarmSuppressionTarget',
    'level': :'level',
    'display_name': :'displayName',
    'description': :'description',
    'dimensions': :'dimensions',
    'time_suppress_from': :'timeSuppressFrom',
    'time_suppress_until': :'timeSuppressUntil',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'suppression_conditions': :'suppressionConditions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 109

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 204

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

  self.class == other.class &&
    alarm_suppression_target == other.alarm_suppression_target &&
    level == other.level &&
    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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 243

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


223
224
225
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 223

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 232

def hash
  [alarm_suppression_target, level, display_name, description, dimensions, time_suppress_from, time_suppress_until, freeform_tags, defined_tags, 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



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 276

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



270
271
272
 
# File 'lib/oci/monitoring/models/create_alarm_suppression_details.rb', line 270

def to_s
  to_hash.to_s
end