class OpsgenieSdk::CreateAlertPayload

Attributes

_alias[RW]

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

actions[RW]

Custom actions that will be available for the alert

description[RW]

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

details[RW]

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

entity[RW]

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

message[RW]

Message of the alert

note[RW]

Additional note that will be added while creating the alert

priority[RW]

Priority level of the alert

responders[RW]

Responders that the alert will be routed to send notifications

source[RW]

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

tags[RW]

Tags of the alert

user[RW]

Display name of the request owner

visible_to[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/opsgenie_sdk/models/create_alert_payload.rb, line 239
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
priority=(priority) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] priority Object to be assigned

# File lib/opsgenie_sdk/models/create_alert_payload.rb, line 209
def priority=(priority)
  validator = EnumAttributeValidator.new('String', ['P1', 'P2', 'P3', 'P4', 'P5'])
  unless validator.valid?(priority)
    fail ArgumentError, 'invalid value for "priority", must be one of #{validator.allowable_values}.'
  end
  @priority = priority
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/opsgenie_sdk/models/create_alert_payload.rb, line 319
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/opsgenie_sdk/models/create_alert_payload.rb, line 313
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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