Class: OpsgenieSdk::EmailBasedIncomingFeature

Inherits:
Object
  • Object
show all
Defined in:
lib/opsgenie_sdk/models/email_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 = {}) ⇒ EmailBasedIncomingFeature

Initializes the object

Parameters:

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

    Model attributes in the form of hash



126
127
128
129
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
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
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 126

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

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

Instance Attribute Details

#assigned_team ⇒ Object

Returns the value of attribute assigned_team.



47
48
49
 
# File 'lib/opsgenie_sdk/models/email_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/email_based_incoming_feature.rb', line 41

def custom_priority
  @custom_priority
end

#email_address ⇒ Object

Returns the value of attribute email_address.



51
52
53
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 51

def email_address
  @email_address
end

#email_username ⇒ Object

The username part of the email address. It must be unique for each integration



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

def email_username
  @email_username
end

#extra_properties ⇒ Object

Returns the value of attribute extra_properties.



45
46
47
 
# File 'lib/opsgenie_sdk/models/email_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/email_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/email_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/email_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/email_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/email_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/email_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/email_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/email_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/email_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/email_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/email_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/email_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.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 79

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',
    :'email_address' => :'emailAddress',
    :'email_username' => :'emailUsername'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 102

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',
    :'email_address' => :'String',
    :'email_username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 236

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 &&
      email_address == o.email_address &&
      email_username == o.email_username
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 294

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



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

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 273

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


260
261
262
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 266

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, email_address, email_username].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



211
212
213
214
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 211

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



340
341
342
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 346

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



334
335
336
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 334

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



218
219
220
221
222
 
# File 'lib/opsgenie_sdk/models/email_based_incoming_feature.rb', line 218

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