Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext::WorkflowCumulativeStatisticsInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext::WorkflowCumulativeStatisticsInstance
- Defined in:
- lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Workflow resource.
-
#avg_task_acceptance_time ⇒ String
The average time in seconds between Task creation and acceptance.
-
#context ⇒ WorkflowCumulativeStatisticsContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#end_time ⇒ Time
The end of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkflowCumulativeStatisticsInstance
Fetch the WorkflowCumulativeStatisticsInstance.
-
#initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowCumulativeStatisticsInstance
constructor
Initialize the WorkflowCumulativeStatisticsInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#reservations_accepted ⇒ String
The total number of Reservations accepted by Workers.
-
#reservations_canceled ⇒ String
The total number of Reservations that were canceled.
-
#reservations_created ⇒ String
The total number of Reservations that were created for Workers.
-
#reservations_rejected ⇒ String
The total number of Reservations that were rejected.
-
#reservations_rescinded ⇒ String
The total number of Reservations that were rescinded.
-
#reservations_timed_out ⇒ String
The total number of Reservations that were timed out.
-
#split_by_wait_time ⇒ Hash
A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds.
-
#start_time ⇒ Time
The beginning of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#tasks_canceled ⇒ String
The total number of Tasks that were canceled.
-
#tasks_completed ⇒ String
The total number of Tasks that were completed.
-
#tasks_deleted ⇒ String
The total number of Tasks that were deleted.
-
#tasks_entered ⇒ String
The total number of Tasks that entered the Workflow.
-
#tasks_moved ⇒ String
The total number of Tasks that were moved from one queue to another.
-
#tasks_timed_out_in_workflow ⇒ String
The total number of Tasks that were timed out of their Workflows (and deleted).
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the Workflow statistics resource.
-
#wait_duration_until_accepted ⇒ Hash
The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were accepted.
-
#wait_duration_until_canceled ⇒ Hash
The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were canceled.
-
#workflow_sid ⇒ String
Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value.
-
#workspace_sid ⇒ String
The SID of the Workspace that contains the Workflow.
Constructor Details
#initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowCumulativeStatisticsInstance
Initialize the WorkflowCumulativeStatisticsInstance
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 147 def initialize(version, payload , workspace_sid: nil, workflow_sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'avg_task_acceptance_time' => payload['avg_task_acceptance_time'] == nil ? payload['avg_task_acceptance_time'] : payload['avg_task_acceptance_time'].to_i, 'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']), 'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']), 'reservations_created' => payload['reservations_created'] == nil ? payload['reservations_created'] : payload['reservations_created'].to_i, 'reservations_accepted' => payload['reservations_accepted'] == nil ? payload['reservations_accepted'] : payload['reservations_accepted'].to_i, 'reservations_rejected' => payload['reservations_rejected'] == nil ? payload['reservations_rejected'] : payload['reservations_rejected'].to_i, 'reservations_timed_out' => payload['reservations_timed_out'] == nil ? payload['reservations_timed_out'] : payload['reservations_timed_out'].to_i, 'reservations_canceled' => payload['reservations_canceled'] == nil ? payload['reservations_canceled'] : payload['reservations_canceled'].to_i, 'reservations_rescinded' => payload['reservations_rescinded'] == nil ? payload['reservations_rescinded'] : payload['reservations_rescinded'].to_i, 'split_by_wait_time' => payload['split_by_wait_time'], 'wait_duration_until_accepted' => payload['wait_duration_until_accepted'], 'wait_duration_until_canceled' => payload['wait_duration_until_canceled'], 'tasks_canceled' => payload['tasks_canceled'] == nil ? payload['tasks_canceled'] : payload['tasks_canceled'].to_i, 'tasks_completed' => payload['tasks_completed'] == nil ? payload['tasks_completed'] : payload['tasks_completed'].to_i, 'tasks_entered' => payload['tasks_entered'] == nil ? payload['tasks_entered'] : payload['tasks_entered'].to_i, 'tasks_deleted' => payload['tasks_deleted'] == nil ? payload['tasks_deleted'] : payload['tasks_deleted'].to_i, 'tasks_moved' => payload['tasks_moved'] == nil ? payload['tasks_moved'] : payload['tasks_moved'].to_i, 'tasks_timed_out_in_workflow' => payload['tasks_timed_out_in_workflow'] == nil ? payload['tasks_timed_out_in_workflow'] : payload['tasks_timed_out_in_workflow'].to_i, 'workflow_sid' => payload['workflow_sid'], 'workspace_sid' => payload['workspace_sid'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'workspace_sid' => workspace_sid || @properties['workspace_sid'] ,'workflow_sid' => workflow_sid || @properties['workflow_sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Workflow resource.
194 195 196 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 194 def account_sid @properties['account_sid'] end |
#avg_task_acceptance_time ⇒ String
Returns The average time in seconds between Task creation and acceptance.
200 201 202 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 200 def avg_task_acceptance_time @properties['avg_task_acceptance_time'] end |
#context ⇒ WorkflowCumulativeStatisticsContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
185 186 187 188 189 190 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 185 def context unless @instance_context @instance_context = WorkflowCumulativeStatisticsContext.new(@version , @params['workspace_sid'], @params['workflow_sid']) end @instance_context end |
#end_time ⇒ Time
Returns The end of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
212 213 214 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 212 def end_time @properties['end_time'] end |
#fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkflowCumulativeStatisticsInstance
Fetch the WorkflowCumulativeStatisticsInstance
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 332 def fetch( end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset ) context.fetch( end_date: end_date, minutes: minutes, start_date: start_date, task_channel: task_channel, split_by_wait_time: split_by_wait_time, ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
358 359 360 361 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 358 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.WorkflowCumulativeStatisticsInstance #{values}>" end |
#reservations_accepted ⇒ String
Returns The total number of Reservations accepted by Workers.
224 225 226 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 224 def reservations_accepted @properties['reservations_accepted'] end |
#reservations_canceled ⇒ String
Returns The total number of Reservations that were canceled.
242 243 244 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 242 def reservations_canceled @properties['reservations_canceled'] end |
#reservations_created ⇒ String
Returns The total number of Reservations that were created for Workers.
218 219 220 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 218 def reservations_created @properties['reservations_created'] end |
#reservations_rejected ⇒ String
Returns The total number of Reservations that were rejected.
230 231 232 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 230 def reservations_rejected @properties['reservations_rejected'] end |
#reservations_rescinded ⇒ String
Returns The total number of Reservations that were rescinded.
248 249 250 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 248 def reservations_rescinded @properties['reservations_rescinded'] end |
#reservations_timed_out ⇒ String
Returns The total number of Reservations that were timed out.
236 237 238 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 236 def reservations_timed_out @properties['reservations_timed_out'] end |
#split_by_wait_time ⇒ Hash
Returns A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds.
254 255 256 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 254 def split_by_wait_time @properties['split_by_wait_time'] end |
#start_time ⇒ Time
Returns The beginning of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
206 207 208 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 206 def start_time @properties['start_time'] end |
#tasks_canceled ⇒ String
Returns The total number of Tasks that were canceled.
272 273 274 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 272 def tasks_canceled @properties['tasks_canceled'] end |
#tasks_completed ⇒ String
Returns The total number of Tasks that were completed.
278 279 280 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 278 def tasks_completed @properties['tasks_completed'] end |
#tasks_deleted ⇒ String
Returns The total number of Tasks that were deleted.
290 291 292 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 290 def tasks_deleted @properties['tasks_deleted'] end |
#tasks_entered ⇒ String
Returns The total number of Tasks that entered the Workflow.
284 285 286 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 284 def tasks_entered @properties['tasks_entered'] end |
#tasks_moved ⇒ String
Returns The total number of Tasks that were moved from one queue to another.
296 297 298 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 296 def tasks_moved @properties['tasks_moved'] end |
#tasks_timed_out_in_workflow ⇒ String
Returns The total number of Tasks that were timed out of their Workflows (and deleted).
302 303 304 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 302 def tasks_timed_out_in_workflow @properties['tasks_timed_out_in_workflow'] end |
#to_s ⇒ Object
Provide a user friendly representation
351 352 353 354 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 351 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.WorkflowCumulativeStatisticsInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the Workflow statistics resource.
320 321 322 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 320 def url @properties['url'] end |
#wait_duration_until_accepted ⇒ Hash
Returns The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were accepted.
260 261 262 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 260 def wait_duration_until_accepted @properties['wait_duration_until_accepted'] end |
#wait_duration_until_canceled ⇒ Hash
Returns The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were canceled.
266 267 268 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 266 def wait_duration_until_canceled @properties['wait_duration_until_canceled'] end |
#workflow_sid ⇒ String
Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value.
308 309 310 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 308 def workflow_sid @properties['workflow_sid'] end |
#workspace_sid ⇒ String
Returns The SID of the Workspace that contains the Workflow.
314 315 316 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 314 def workspace_sid @properties['workspace_sid'] end |