class PureCloud::QueueUtilizationDiagnostic

Attributes

active_users_in_queue[RW]

The number of users active on the queue

queue[RW]

Identifier of the queue

users_in_queue[RW]

The number of users joined to the queue

users_not_utilized[RW]

The number of users in the queue currently not engaged

users_on_a_campaign_call[RW]

The number of users currently engaged in a campaign call

users_on_a_non_campaign_call[RW]

The number of users currently engaged in a communication that is not part of the campaign

users_on_different_edge_group[RW]

The number of users whose station is homed to an edge different from the campaign

users_on_queue[RW]

The number of users with a status of on-queue

users_on_queue_with_station[RW]

The number of users in the queue with a station

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb, line 49
def self.attribute_map
  {
    
    :'queue' => :'queue',
    
    :'users_in_queue' => :'usersInQueue',
    
    :'active_users_in_queue' => :'activeUsersInQueue',
    
    :'users_on_queue' => :'usersOnQueue',
    
    :'users_not_utilized' => :'usersNotUtilized',
    
    :'users_on_queue_with_station' => :'usersOnQueueWithStation',
    
    :'users_on_a_campaign_call' => :'usersOnACampaignCall',
    
    :'users_on_different_edge_group' => :'usersOnDifferentEdgeGroup',
    
    :'users_on_a_non_campaign_call' => :'usersOnANonCampaignCall'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb, line 74
def self.swagger_types
  {
    
    :'queue' => :'DomainEntityRef',
    
    :'users_in_queue' => :'Integer',
    
    :'active_users_in_queue' => :'Integer',
    
    :'users_on_queue' => :'Integer',
    
    :'users_not_utilized' => :'Integer',
    
    :'users_on_queue_with_station' => :'Integer',
    
    :'users_on_a_campaign_call' => :'Integer',
    
    :'users_on_different_edge_group' => :'Integer',
    
    :'users_on_a_non_campaign_call' => :'Integer'
    
  }
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/queue_utilization_diagnostic.rb, line 289
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      queue == o.queue &&
      users_in_queue == o.users_in_queue &&
      active_users_in_queue == o.active_users_in_queue &&
      users_on_queue == o.users_on_queue &&
      users_not_utilized == o.users_not_utilized &&
      users_on_queue_with_station == o.users_on_queue_with_station &&
      users_on_a_campaign_call == o.users_on_a_campaign_call &&
      users_on_different_edge_group == o.users_on_different_edge_group &&
      users_on_a_non_campaign_call == o.users_on_a_non_campaign_call
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb, line 335
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/queue_utilization_diagnostic.rb, line 395
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/queue_utilization_diagnostic.rb, line 316
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/queue_utilization_diagnostic.rb, line 305
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/queue_utilization_diagnostic.rb, line 311
def hash
  [queue, users_in_queue, active_users_in_queue, users_on_queue, users_not_utilized, users_on_queue_with_station, users_on_a_campaign_call, users_on_different_edge_group, users_on_a_non_campaign_call].hash
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/queue_utilization_diagnostic.rb, line 192
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/queue_utilization_diagnostic.rb, line 378
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb, line 383
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/queue_utilization_diagnostic.rb, line 373
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/queue_utilization_diagnostic.rb, line 201
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end