Class: OpsgenieSdk::CreateAlertPayload

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAlertPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



118
119
120
121
122
123
124
125
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
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 118

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

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

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

  if attributes.has_key?(:'message')
    self.message = attributes[:'message']
  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?(:'responders')
    if (value = attributes[:'responders']).is_a?(Array)
      self.responders = value
    end
  end

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

  if attributes.has_key?(:'actions')
    if (value = attributes[:'actions']).is_a?(Array)
      self.actions = 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?(:'entity')
    self.entity = attributes[:'entity']
  end

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

Instance Attribute Details

#_alias ⇒ Object

Client-defined identifier of the alert, that is also the key element of alert deduplication.



30
31
32
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 30

def _alias
  @_alias
end

#actions ⇒ Object

Custom actions that will be available for the alert



42
43
44
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 42

def actions
  @actions
end

#description ⇒ Object

Description field of the alert that is generally used to provide a detailed information about the alert.



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

def description
  @description
end

#details ⇒ Object

Map of key-value pairs to use as custom properties of the alert



48
49
50
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 48

def details
  @details
end

#entity ⇒ Object

Entity field of the alert that is generally used to specify which domain alert is related to



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

def entity
  @entity
end

#message ⇒ Object

Message of the alert



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

def message
  @message
end

#note ⇒ Object

Additional note that will be added while creating the alert



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

def note
  @note
end

#priority ⇒ Object

Priority level of the alert



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

def priority
  @priority
end

#responders ⇒ Object

Responders that the alert will be routed to send notifications



36
37
38
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 36

def responders
  @responders
end

#source ⇒ Object

Source field of the alert. Default value is IP address of the incoming request



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

def source
  @source
end

#tags ⇒ Object

Tags of the alert



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

def tags
  @tags
end

#user ⇒ Object

Display name of the request owner



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

def user
  @user
end

#visible_to ⇒ Object

Teams and users that the alert will become visible to without sending any notification



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

def visible_to
  @visible_to
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
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 79

def self.attribute_map
  {
    :'user' => :'user',
    :'note' => :'note',
    :'source' => :'source',
    :'message' => :'message',
    :'_alias' => :'alias',
    :'description' => :'description',
    :'responders' => :'responders',
    :'visible_to' => :'visibleTo',
    :'actions' => :'actions',
    :'tags' => :'tags',
    :'details' => :'details',
    :'entity' => :'entity',
    :'priority' => :'priority'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 98

def self.swagger_types
  {
    :'user' => :'String',
    :'note' => :'String',
    :'source' => :'String',
    :'message' => :'String',
    :'_alias' => :'String',
    :'description' => :'String',
    :'responders' => :'Array<Recipient>',
    :'visible_to' => :'Array<Recipient>',
    :'actions' => :'Array<String>',
    :'tags' => :'Array<String>',
    :'details' => :'Hash<String, String>',
    :'entity' => :'String',
    :'priority' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user == o.user &&
      note == o.note &&
      source == o.source &&
      message == o.message &&
      _alias == o._alias &&
      description == o.description &&
      responders == o.responders &&
      visible_to == o.visible_to &&
      actions == o.actions &&
      tags == o.tags &&
      details == o.details &&
      entity == o.entity &&
      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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 273

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 339

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 252

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


239
240
241
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 245

def hash
  [user, note, source, message, _alias, description, responders, visible_to, actions, tags, details, entity, priority].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



189
190
191
192
193
194
195
196
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 189

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

  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



319
320
321
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 319

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



325
326
327
328
329
330
331
332
333
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 325

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



313
314
315
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 313

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



200
201
202
203
204
205
 
# File 'lib/opsgenie_sdk/models/create_alert_payload.rb', line 200

def valid?
  return false if @message.nil?
  priority_validator = EnumAttributeValidator.new('String', ['P1', 'P2', 'P3', 'P4', 'P5'])
  return false unless priority_validator.valid?(@priority)
  true
end