class PureCloud::AnalyticsQueryPredicate

Attributes

dimension[RW]

Left hand side for dimension predicates

metric[RW]

Left hand side for metric predicates

operator[RW]

Optional operator, default is matches

property[RW]

Left hand side for property predicates

property_type[RW]

Left hand side for property predicates

range[RW]

Right hand side for property or metric predicates

type[RW]

Optional type, can usually be inferred

value[RW]

Right hand side for dimension, property, or metric predicates

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/analytics_query_predicate.rb, line 46
def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'dimension' => :'dimension',
    
    :'property_type' => :'propertyType',
    
    :'property' => :'property',
    
    :'metric' => :'metric',
    
    :'operator' => :'operator',
    
    :'value' => :'value',
    
    :'range' => :'range'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/analytics_query_predicate.rb, line 83
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'dimension']
    self.dimension = attributes[:'dimension']
  end
  
  if attributes[:'propertyType']
    self.property_type = attributes[:'propertyType']
  end
  
  if attributes[:'property']
    self.property = attributes[:'property']
  end
  
  if attributes[:'metric']
    self.metric = attributes[:'metric']
  end
  
  if attributes[:'operator']
    self.operator = attributes[:'operator']
  end
  
  if attributes[:'value']
    self.value = attributes[:'value']
  end
  
  if attributes[:'range']
    self.range = attributes[:'range']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/analytics_query_predicate.rb, line 69
def self.swagger_types
  {
    :'type' => :'String',
    :'dimension' => :'String',
    :'property_type' => :'String',
    :'property' => :'String',
    :'metric' => :'String',
    :'operator' => :'String',
    :'value' => :'String',
    :'range' => :'NumericRange'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/analytics_query_predicate.rb, line 170
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      dimension == o.dimension &&
      property_type == o.property_type &&
      property == o.property &&
      metric == o.metric &&
      operator == o.operator &&
      value == o.value &&
      range == o.range
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/analytics_query_predicate.rb, line 213
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/purecloud/models/analytics_query_predicate.rb, line 273
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/purecloud/models/analytics_query_predicate.rb, line 194
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
dimension=(dimension) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/analytics_query_predicate.rb, line 134
def dimension=(dimension)
  allowed_values = ["conversationId", "sessionId", "mediaType", "queueId", "userId", "participantId", "participantName", "direction", "wrapUpCode", "wrapUpNote", "interactionType", "requestedRoutingSkillId", "requestedLanguageId", "purpose", "participantType", "segmentType", "disconnectType", "errorCode", "conversationEnd", "externalContactId", "externalOrganizationId", "stationId", "edgeId", "dnis", "ani", "outboundCampaignId", "outboundContactId", "outboundContactListId", "monitoredParticipantId", "sourceSessionId", "destinationSessionId", "sourceConversationId", "destinationConversationId", "remoteNameDisplayable", "sipResponseCode", "q850ResponseCode", "conference", "groupId", "roomId", "addressFrom", "addressTo", "subject", "peerId", "scriptId", "evaluationId", "evaluatorId", "contextId", "formId", "formName", "eventTime", "systemPresence", "organizationPresenceId", "routingStatus"]
  if dimension && !allowed_values.include?(dimension)
    fail "invalid value for 'dimension', must be one of #{allowed_values}"
  end
  @dimension = dimension
end
eql?(o) click to toggle source

@see the `==` method

# File lib/purecloud/models/analytics_query_predicate.rb, line 184
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/analytics_query_predicate.rb, line 189
def hash
  [type, dimension, property_type, property, metric, operator, value, range].hash
end
metric=(metric) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/analytics_query_predicate.rb, line 152
def metric=(metric)
  allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers"]
  if metric && !allowed_values.include?(metric)
    fail "invalid value for 'metric', must be one of #{allowed_values}"
  end
  @metric = metric
end
operator=(operator) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/analytics_query_predicate.rb, line 161
def operator=(operator)
  allowed_values = ["matches", "exists", "notExists"]
  if operator && !allowed_values.include?(operator)
    fail "invalid value for 'operator', must be one of #{allowed_values}"
  end
  @operator = operator
end
property_type=(property_type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/analytics_query_predicate.rb, line 143
def property_type=(property_type)
  allowed_values = ["bool", "integer", "real", "date", "string", "uuid"]
  if property_type && !allowed_values.include?(property_type)
    fail "invalid value for 'property_type', must be one of #{allowed_values}"
  end
  @property_type = property_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/analytics_query_predicate.rb, line 256
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/analytics_query_predicate.rb, line 261
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/purecloud/models/analytics_query_predicate.rb, line 251
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/analytics_query_predicate.rb, line 125
def type=(type)
  allowed_values = ["dimension", "property", "metric"]
  if type && !allowed_values.include?(type)
    fail "invalid value for 'type', must be one of #{allowed_values}"
  end
  @type = type
end