Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueContext::TaskQueueRealTimeStatisticsInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, task_queue_sid: nil) ⇒ TaskQueueRealTimeStatisticsInstance

Initialize the TaskQueueRealTimeStatisticsInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • workspace_sid (String) (defaults to: nil) —

    The workspace_sid

  • task_queue_sid (String) (defaults to: nil) —

    The task_queue_sid



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 131

def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'activity_statistics' => payload['activity_statistics'],
      'longest_task_waiting_age' => payload['longest_task_waiting_age'].to_i,
      'longest_task_waiting_sid' => payload['longest_task_waiting_sid'],
      'task_queue_sid' => payload['task_queue_sid'],
      'tasks_by_priority' => payload['tasks_by_priority'],
      'tasks_by_status' => payload['tasks_by_status'],
      'total_available_workers' => payload['total_available_workers'].to_i,
      'total_eligible_workers' => payload['total_eligible_workers'].to_i,
      'total_tasks' => payload['total_tasks'].to_i,
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid, }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



172
173
174
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 172

def 
  @properties['account_sid']
end

#activity_statistics ⇒ Hash

Returns The current Worker status count breakdown by Activity.

Returns:

  • (Hash) —

    The current Worker status count breakdown by Activity



178
179
180
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 178

def activity_statistics
  @properties['activity_statistics']
end

#context ⇒ TaskQueueRealTimeStatisticsContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 159

def context
  unless @instance_context
    @instance_context = TaskQueueRealTimeStatisticsContext.new(
        @version,
        @params['workspace_sid'],
        @params['task_queue_sid'],
    )
  end
  @instance_context
end

#fetch(task_channel: :unset) ⇒ TaskQueueRealTimeStatisticsInstance

Fetch a TaskQueueRealTimeStatisticsInstance

Parameters:

  • task_channel (String) (defaults to: :unset) —

    Filter real-time and cumulative statistics by TaskChannel. Takes in a Unique Name (“voice”, “sms”, “default”, etc.) or a TaskChannelSid.

Returns:



248
249
250
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 248

def fetch(task_channel: :unset)
  context.fetch(task_channel: task_channel, )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



261
262
263
264
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 261

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.TaskQueueRealTimeStatisticsInstance #{values}>"
end

#longest_task_waiting_age ⇒ String

Returns The age of the longest waiting Task.

Returns:

  • (String) —

    The age of the longest waiting Task



184
185
186
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 184

def longest_task_waiting_age
  @properties['longest_task_waiting_age']
end

#longest_task_waiting_sid ⇒ String

Returns The SID of the longest waiting Task.

Returns:

  • (String) —

    The SID of the longest waiting Task



190
191
192
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 190

def longest_task_waiting_sid
  @properties['longest_task_waiting_sid']
end

#task_queue_sid ⇒ String

Returns The task_queue_sid.

Returns:

  • (String) —

    The task_queue_sid



196
197
198
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 196

def task_queue_sid
  @properties['task_queue_sid']
end

#tasks_by_priority ⇒ Hash

Returns The Tasks broken down by priority.

Returns:

  • (Hash) —

    The Tasks broken down by priority



202
203
204
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 202

def tasks_by_priority
  @properties['tasks_by_priority']
end

#tasks_by_status ⇒ Hash

Returns The Tasks broken down by status.

Returns:

  • (Hash) —

    The Tasks broken down by status



208
209
210
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 208

def tasks_by_status
  @properties['tasks_by_status']
end

#to_s ⇒ Object

Provide a user friendly representation



254
255
256
257
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 254

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.TaskQueueRealTimeStatisticsInstance #{values}>"
end

#total_available_workers ⇒ String

Returns The total number of Workers available for Tasks in this TaskQueue.

Returns:

  • (String) —

    The total number of Workers available for Tasks in this TaskQueue



214
215
216
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 214

def total_available_workers
  @properties['total_available_workers']
end

#total_eligible_workers ⇒ String

Returns The total number of Workers eligible for Tasks in this TaskQueue, irrespective of Activity state.

Returns:

  • (String) —

    The total number of Workers eligible for Tasks in this TaskQueue, irrespective of Activity state.



220
221
222
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 220

def total_eligible_workers
  @properties['total_eligible_workers']
end

#total_tasks ⇒ String

Returns The total number of Tasks.

Returns:

  • (String) —

    The total number of Tasks



226
227
228
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 226

def total_tasks
  @properties['total_tasks']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



238
239
240
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 238

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



232
233
234
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb', line 232

def workspace_sid
  @properties['workspace_sid']
end