Class: OpsgenieSdk::DeprecatedModifyAlertPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeprecatedModifyAlertPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
271
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 166

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 }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'policyDescription')
    self.policy_description = attributes[:'policyDescription']
  end

  if attributes.has_key?(:'filter')
    self.filter = attributes[:'filter']
  end

  if attributes.has_key?(:'timeRestrictions')
    self.time_restrictions = attributes[:'timeRestrictions']
  end

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'ignoreOriginalAlertActions')
    self.ignore_original_alert_actions = attributes[:'ignoreOriginalAlertActions']
  end

  if attributes.has_key?(:'ignoreOriginalDetails')
    self.ignore_original_details = attributes[:'ignoreOriginalDetails']
  end

  if attributes.has_key?(:'ignoreOriginalRecipients')
    self.ignore_original_recipients = attributes[:'ignoreOriginalRecipients']
  end

  if attributes.has_key?(:'ignoreOriginalTags')
    self.ignore_original_tags = attributes[:'ignoreOriginalTags']
  end

  if attributes.has_key?(:'ignoreOriginalTeams')
    self.ignore_original_teams = attributes[:'ignoreOriginalTeams']
  end

  if attributes.has_key?(:'continue')
    self.continue = attributes[:'continue']
  end

  if attributes.has_key?(:'alias')
    self._alias = attributes[:'alias']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'entity')
    self.entity = attributes[:'entity']
  end

  if attributes.has_key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.has_key?(:'source')
    self.source = attributes[:'source']
  end

  if attributes.has_key?(:'actions')
    if (value = attributes[:'actions']).is_a?(Array)
      self.actions = value
    end
  end

  if attributes.has_key?(:'recipients')
    if (value = attributes[:'recipients']).is_a?(Array)
      self.recipients = value
    end
  end

  if attributes.has_key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.has_key?(:'details')
    if (value = attributes[:'details']).is_a?(Hash)
      self.details = value
    end
  end

  if attributes.has_key?(:'priority')
    self.priority = attributes[:'priority']
  end
end

Instance Attribute Details

#_aliasObject

Alias of the alert. You can use {alias} to refer to the original alias. Default value is {alias}



55
56
57
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 55

def _alias
  @_alias
end

#actionsObject

Alert actions as a list of strings to add to the alerts original actions value. If ignoreOriginalAlertActions field is set to true, this will replace the original actions.



70
71
72
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 70

def actions
  @actions
end

#continueObject

Will continue with other modify policies if set to true



52
53
54
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 52

def continue
  @continue
end

#descriptionObject

Description of the alert. You can use {description} to refer to the original alert description. Default value is {description}



58
59
60
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 58

def description
  @description
end

#detailsObject

Custom properties to add to the alerts original details value as a list of strings. If ignoreOriginalDetails field is set to true, this will replace the original details.



79
80
81
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 79

def details
  @details
end

#enabledObject

Activity status of the alert policy



32
33
34
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 32

def enabled
  @enabled
end

#entityObject

Entity field of the alert. You can use {entity} to refer to the original entity. Default value is {entity}



61
62
63
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 61

def entity
  @entity
end

#filterObject

Conditions specified in this field must be met for this policy to work



26
27
28
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 26

def filter
  @filter
end

#idObject

Returns the value of attribute id.



17
18
19
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 17

def id
  @id
end

#ignore_original_alert_actionsObject

Returns the value of attribute ignore_original_alert_actions.



37
38
39
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 37

def ignore_original_alert_actions
  @ignore_original_alert_actions
end

#ignore_original_detailsObject

If set to true, policy will ignore the original details of the alert. Default value is false



40
41
42
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 40

def ignore_original_details
  @ignore_original_details
end

#ignore_original_recipientsObject

If set to true, policy will ignore the original recipients of the alert. Default value is false



43
44
45
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 43

def ignore_original_recipients
  @ignore_original_recipients
end

#ignore_original_tagsObject

If set to true, policy will ignore the original tags of the alert. Default value is false



46
47
48
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 46

def ignore_original_tags
  @ignore_original_tags
end

#ignore_original_teamsObject

If set to true, policy will ignore the original teams of the alert. Default value is false



49
50
51
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 49

def ignore_original_teams
  @ignore_original_teams
end

#messageObject

Message of the alert



64
65
66
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 64

def message
  @message
end

#nameObject

Name of the policy



20
21
22
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 20

def name
  @name
end

#policy_descriptionObject

Description of the policy



23
24
25
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 23

def policy_description
  @policy_description
end

#priorityObject

Priority level of the alert



82
83
84
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 82

def priority
  @priority
end

#recipientsObject

Recipients to add to the alerts original recipients value as a list of escalations, schedules, teams, users or the reserved word none or all. If ignoreOriginalRecipients field is set to true, this will replace the original recipients.



73
74
75
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 73

def recipients
  @recipients
end

#sourceObject

Source field of the alert. You can use {source} to refer to the original source. Default value is {source}



67
68
69
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 67

def source
  @source
end

#tagsObject

Tags to add to the alerts original tags value as a list of strings. If ignoreOriginalRecipients field is set to true, this will replace the original recipients.



76
77
78
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 76

def tags
  @tags
end

#time_restrictionsObject

Time restrictions specified in this field must be met for this policy to work



29
30
31
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 29

def time_restrictions
  @time_restrictions
end

#typeObject

Type of the policy



35
36
37
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 35

def type
  @type
end

Class Method Details

.attribute_mapObject

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 107

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'policy_description' => :'policyDescription',
    :'filter' => :'filter',
    :'time_restrictions' => :'timeRestrictions',
    :'enabled' => :'enabled',
    :'type' => :'type',
    :'ignore_original_alert_actions' => :'ignoreOriginalAlertActions',
    :'ignore_original_details' => :'ignoreOriginalDetails',
    :'ignore_original_recipients' => :'ignoreOriginalRecipients',
    :'ignore_original_tags' => :'ignoreOriginalTags',
    :'ignore_original_teams' => :'ignoreOriginalTeams',
    :'continue' => :'continue',
    :'_alias' => :'alias',
    :'description' => :'description',
    :'entity' => :'entity',
    :'message' => :'message',
    :'source' => :'source',
    :'actions' => :'actions',
    :'recipients' => :'recipients',
    :'tags' => :'tags',
    :'details' => :'details',
    :'priority' => :'priority'
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 136

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'policy_description' => :'String',
    :'filter' => :'Filter',
    :'time_restrictions' => :'TimeRestrictionInterval',
    :'enabled' => :'BOOLEAN',
    :'type' => :'String',
    :'ignore_original_alert_actions' => :'BOOLEAN',
    :'ignore_original_details' => :'BOOLEAN',
    :'ignore_original_recipients' => :'BOOLEAN',
    :'ignore_original_tags' => :'BOOLEAN',
    :'ignore_original_teams' => :'BOOLEAN',
    :'continue' => :'BOOLEAN',
    :'_alias' => :'String',
    :'description' => :'String',
    :'entity' => :'String',
    :'message' => :'String',
    :'source' => :'String',
    :'actions' => :'Array<String>',
    :'recipients' => :'Array<Recipient>',
    :'tags' => :'Array<String>',
    :'details' => :'Hash<String, String>',
    :'priority' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      policy_description == o.policy_description &&
      filter == o.filter &&
      time_restrictions == o.time_restrictions &&
      enabled == o.enabled &&
      type == o.type &&
      ignore_original_alert_actions == o.ignore_original_alert_actions &&
      ignore_original_details == o.ignore_original_details &&
      ignore_original_recipients == o.ignore_original_recipients &&
      ignore_original_tags == o.ignore_original_tags &&
      ignore_original_teams == o.ignore_original_teams &&
      continue == o.continue &&
      _alias == o._alias &&
      description == o.description &&
      entity == o.entity &&
      message == o.message &&
      source == o.source &&
      actions == o.actions &&
      recipients == o.recipients &&
      tags == o.tags &&
      details == o.details &&
      priority == o.priority
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 381

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = OpsgenieSdk.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



447
448
449
450
451
452
453
454
455
456
457
458
459
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 447

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 360

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


347
348
349
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 347

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



353
354
355
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 353

def hash
  [id, name, policy_description, filter, time_restrictions, enabled, type, ignore_original_alert_actions, ignore_original_details, ignore_original_recipients, ignore_original_tags, ignore_original_teams, continue, _alias, description, entity, message, source, actions, recipients, tags, details, priority].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



275
276
277
278
279
280
281
282
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 275

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



427
428
429
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 427

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



433
434
435
436
437
438
439
440
441
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 433

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



421
422
423
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 421

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



286
287
288
289
290
291
292
293
# File 'lib/opsgenie_sdk/models/deprecated_modify_alert_policy.rb', line 286

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['modify', 'auto-close', 'notification-delay', 'notification-deduplication', 'notification-suppress', 'notification-renotify', 'auto-restart-notifications'])
  return false unless type_validator.valid?(@type)
  priority_validator = EnumAttributeValidator.new('String', ['P1', 'P2', 'P3', 'P4', 'P5'])
  return false unless priority_validator.valid?(@priority)
  true
end