class PureCloud::IntegrationEvent

Describes an event that has happened related to an integration

Attributes

context_attributes[RW]

Map of context attributes specific to this event.

correlation_id[RW]

Correlation ID for the event

detail_message[RW]

Message with additional details about the event. (e.g. an exception cause.)

entities[RW]

Collection of entities affected by or pertaining to the event (e.g. a list of Integrations or Bridge connectors)

event_code[RW]

A classification for the event. Suitable for programmatic searching, sorting, or filtering

id[RW]

Unique ID for this event

level[RW]

Indicates the severity of the event.

message[RW]

Message indicating what happened

self_uri[RW]

The URI for this object

timestamp[RW]

Time the event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

user[RW]

User that took an action that resulted in the event.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 56
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'self_uri' => :'selfUri',
    
    :'correlation_id' => :'correlationId',
    
    :'timestamp' => :'timestamp',
    
    :'level' => :'level',
    
    :'event_code' => :'eventCode',
    
    :'message' => :'message',
    
    :'entities' => :'entities',
    
    :'context_attributes' => :'contextAttributes',
    
    :'detail_message' => :'detailMessage',
    
    :'user' => :'user'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 115
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?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 85
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'self_uri' => :'String',
    
    :'correlation_id' => :'String',
    
    :'timestamp' => :'DateTime',
    
    :'level' => :'String',
    
    :'event_code' => :'String',
    
    :'message' => :'MessageInfo',
    
    :'entities' => :'Array<EventEntity>',
    
    :'context_attributes' => :'Hash<String, String>',
    
    :'detail_message' => :'MessageInfo',
    
    :'user' => :'User'
    
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 358
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      self_uri == o.self_uri &&
      correlation_id == o.correlation_id &&
      timestamp == o.timestamp &&
      level == o.level &&
      event_code == o.event_code &&
      message == o.message &&
      entities == o.entities &&
      context_attributes == o.context_attributes &&
      detail_message == o.detail_message &&
      user == o.user
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/integration_event.rb, line 406
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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 466
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

build the object from hash

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 387
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 376
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 382
def hash
  [id, self_uri, correlation_id, timestamp, level, event_code, message, entities, context_attributes, detail_message, user].hash
end
level=(level) click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 315
def level=(level)
  allowed_values = ["INFO", "WARN", "ERROR", "CRITICAL"]
  if level && !allowed_values.include?(level)
    fail ArgumentError, "invalid value for 'level', must be one of #{allowed_values}."
  end
  @level = level
end
list_invalid_properties() click to toggle source

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

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 229
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 449
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/integration_event.rb, line 454
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
# File lib/purecloudplatformclientv2/models/integration_event.rb, line 444
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/purecloudplatformclientv2/models/integration_event.rb, line 238
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["INFO", "WARN", "ERROR", "CRITICAL"]
  if @level && !allowed_values.include?(@level)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end