Class: OpsgenieSdk::TokenBasedIncomingFeature

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TokenBasedIncomingFeature

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'suppressNotifications')
    self.suppress_notifications = attributes[:'suppressNotifications']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_configuration_access ⇒ Object

This parameter is for allowing or restricting the configuration access. If configuration access is restricted, the integration will be limited to Alert API requests and sending heartbeats. Defaults to false



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

def allow_configuration_access
  @allow_configuration_access
end

#allow_delete_access ⇒ Object

Returns the value of attribute allow_delete_access.



59
60
61
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 59

def allow_delete_access
  @allow_delete_access
end

#allow_read_access ⇒ Object

Returns the value of attribute allow_read_access.



54
55
56
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 54

def allow_read_access
  @allow_read_access
end

#allow_write_access ⇒ Object

This parameter is for configuring the read-only access of integration. If the integration is limited to read-only access, the integration will not be authorized to perform any create, update or delete action within any domain. Defaults to true



57
58
59
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 57

def allow_write_access
  @allow_write_access
end

#assigned_team ⇒ Object

Returns the value of attribute assigned_team.



47
48
49
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 47

def assigned_team
  @assigned_team
end

#custom_priority ⇒ Object

Returns the value of attribute custom_priority.



41
42
43
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 41

def custom_priority
  @custom_priority
end

#extra_properties ⇒ Object

Returns the value of attribute extra_properties.



45
46
47
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 45

def extra_properties
  @extra_properties
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



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

def feature_type
  @feature_type
end

#ignore_extra_properties_from_payload ⇒ Object

Returns the value of attribute ignore_extra_properties_from_payload.



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

def ignore_extra_properties_from_payload
  @ignore_extra_properties_from_payload
end

#ignore_recipients_from_payload ⇒ Object

If enabled, the integration will ignore recipients sent in request payloads. Defaults to false



24
25
26
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 24

def ignore_recipients_from_payload
  @ignore_recipients_from_payload
end

#ignore_responders_from_payload ⇒ Object

Returns the value of attribute ignore_responders_from_payload.



31
32
33
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 31

def ignore_responders_from_payload
  @ignore_responders_from_payload
end

#ignore_tags_from_payload ⇒ Object

Returns the value of attribute ignore_tags_from_payload.



33
34
35
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 33

def ignore_tags_from_payload
  @ignore_tags_from_payload
end

#ignore_teams_from_payload ⇒ Object

If enabled, the integration will ignore teams sent in request payloads. Defaults to false



21
22
23
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 21

def ignore_teams_from_payload
  @ignore_teams_from_payload
end

#is_advanced ⇒ Object

Returns the value of attribute is_advanced.



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

def is_advanced
  @is_advanced
end

#priority ⇒ Object

Returns the value of attribute priority.



39
40
41
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 39

def priority
  @priority
end

#recipients ⇒ Object

Optional user, schedule, teams or escalation names to calculate which users will receive the notifications of the alert. Recipients which are exceeding the limit are ignored



27
28
29
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 27

def recipients
  @recipients
end

#responders ⇒ Object

Returns the value of attribute responders.



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

def responders
  @responders
end

#suppress_notifications ⇒ Object

If enabled, notifications that come from alerts will be suppressed. Defaults to false



18
19
20
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 18

def suppress_notifications
  @suppress_notifications
end

#tags ⇒ Object

Returns the value of attribute tags.



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

def tags
  @tags
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 84

def self.attribute_map
  {
    :'suppress_notifications' => :'suppressNotifications',
    :'ignore_teams_from_payload' => :'ignoreTeamsFromPayload',
    :'ignore_recipients_from_payload' => :'ignoreRecipientsFromPayload',
    :'recipients' => :'recipients',
    :'is_advanced' => :'isAdvanced',
    :'ignore_responders_from_payload' => :'ignoreRespondersFromPayload',
    :'ignore_tags_from_payload' => :'ignoreTagsFromPayload',
    :'ignore_extra_properties_from_payload' => :'ignoreExtraPropertiesFromPayload',
    :'responders' => :'responders',
    :'priority' => :'priority',
    :'custom_priority' => :'customPriority',
    :'tags' => :'tags',
    :'extra_properties' => :'extraProperties',
    :'assigned_team' => :'assignedTeam',
    :'feature_type' => :'feature-type',
    :'allow_configuration_access' => :'allowConfigurationAccess',
    :'allow_read_access' => :'allowReadAccess',
    :'allow_write_access' => :'allowWriteAccess',
    :'allow_delete_access' => :'allowDeleteAccess'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'suppress_notifications' => :'BOOLEAN',
    :'ignore_teams_from_payload' => :'BOOLEAN',
    :'ignore_recipients_from_payload' => :'BOOLEAN',
    :'recipients' => :'Array<Recipient>',
    :'is_advanced' => :'BOOLEAN',
    :'ignore_responders_from_payload' => :'BOOLEAN',
    :'ignore_tags_from_payload' => :'BOOLEAN',
    :'ignore_extra_properties_from_payload' => :'BOOLEAN',
    :'responders' => :'Array<Recipient>',
    :'priority' => :'String',
    :'custom_priority' => :'String',
    :'tags' => :'Array<String>',
    :'extra_properties' => :'Hash<String, String>',
    :'assigned_team' => :'TeamMeta',
    :'feature_type' => :'String',
    :'allow_configuration_access' => :'BOOLEAN',
    :'allow_read_access' => :'BOOLEAN',
    :'allow_write_access' => :'BOOLEAN',
    :'allow_delete_access' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      suppress_notifications == o.suppress_notifications &&
      ignore_teams_from_payload == o.ignore_teams_from_payload &&
      ignore_recipients_from_payload == o.ignore_recipients_from_payload &&
      recipients == o.recipients &&
      is_advanced == o.is_advanced &&
      ignore_responders_from_payload == o.ignore_responders_from_payload &&
      ignore_tags_from_payload == o.ignore_tags_from_payload &&
      ignore_extra_properties_from_payload == o.ignore_extra_properties_from_payload &&
      responders == o.responders &&
      priority == o.priority &&
      custom_priority == o.custom_priority &&
      tags == o.tags &&
      extra_properties == o.extra_properties &&
      assigned_team == o.assigned_team &&
      feature_type == o.feature_type &&
      allow_configuration_access == o.allow_configuration_access &&
      allow_read_access == o.allow_read_access &&
      allow_write_access == o.allow_write_access &&
      allow_delete_access == o.allow_delete_access
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



313
314
315
316
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
344
345
346
347
348
349
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 313

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 379

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 292

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


279
280
281
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 285

def hash
  [suppress_notifications, ignore_teams_from_payload, ignore_recipients_from_payload, recipients, is_advanced, ignore_responders_from_payload, ignore_tags_from_payload, ignore_extra_properties_from_payload, responders, priority, custom_priority, tags, extra_properties, assigned_team, feature_type, allow_configuration_access, allow_read_access, allow_write_access, allow_delete_access].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



228
229
230
231
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 228

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



359
360
361
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 359

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



365
366
367
368
369
370
371
372
373
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 365

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

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



235
236
237
238
239
 
# File 'lib/opsgenie_sdk/models/token_based_incoming_feature.rb', line 235

def valid?
  feature_type_validator = EnumAttributeValidator.new('String', ['email-based', 'token-based'])
  return false unless feature_type_validator.valid?(@feature_type)
  true
end