Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueInstance
- Defined in:
- lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#assignment_activity_name ⇒ String
The name of the Activity to assign Workers when a task is assigned for them.
-
#assignment_activity_sid ⇒ String
The SID of the Activity to assign Workers when a task is assigned for them.
-
#context ⇒ TaskQueueContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#cumulative_statistics ⇒ cumulative_statistics
Access the cumulative_statistics.
-
#date_created ⇒ Time
The RFC 2822 date and time in GMT when the resource was created.
-
#date_updated ⇒ Time
The RFC 2822 date and time in GMT when the resource was last updated.
-
#delete ⇒ Boolean
Delete the TaskQueueInstance.
-
#fetch ⇒ TaskQueueInstance
Fetch the TaskQueueInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ TaskQueueInstance
constructor
Initialize the TaskQueueInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ String
The URLs of related resources.
-
#max_reserved_workers ⇒ String
The maximum number of Workers to reserve.
-
#real_time_statistics ⇒ real_time_statistics
Access the real_time_statistics.
-
#reservation_activity_name ⇒ String
The name of the Activity to assign Workers once a task is reserved for them.
-
#reservation_activity_sid ⇒ String
The SID of the Activity to assign Workers once a task is reserved for them.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#statistics ⇒ statistics
Access the statistics.
-
#target_workers ⇒ String
A string describing the Worker selection criteria for any Tasks that enter the TaskQueue.
-
#task_order ⇒ task_queue.TaskOrder
How Tasks will be assigned to Workers.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset) ⇒ TaskQueueInstance
Update the TaskQueueInstance.
-
#url ⇒ String
The absolute URL of the TaskQueue resource.
-
#workspace_sid ⇒ String
The SID of the Workspace that contains the TaskQueue.
Constructor Details
#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ TaskQueueInstance
Initialize the TaskQueueInstance
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 360 def initialize(version, payload, workspace_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'assignment_activity_sid' => payload['assignment_activity_sid'], 'assignment_activity_name' => payload['assignment_activity_name'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'friendly_name' => payload['friendly_name'], 'max_reserved_workers' => payload['max_reserved_workers'].to_i, 'reservation_activity_sid' => payload['reservation_activity_sid'], 'reservation_activity_name' => payload['reservation_activity_name'], 'sid' => payload['sid'], 'target_workers' => payload['target_workers'], 'task_order' => payload['task_order'], 'url' => payload['url'], 'workspace_sid' => payload['workspace_sid'], 'links' => payload['links'], } # Context @instance_context = nil @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the Account that created the resource.
400 401 402 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 400 def account_sid @properties['account_sid'] end |
#assignment_activity_name ⇒ String
Returns The name of the Activity to assign Workers when a task is assigned for them.
412 413 414 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 412 def assignment_activity_name @properties['assignment_activity_name'] end |
#assignment_activity_sid ⇒ String
Returns The SID of the Activity to assign Workers when a task is assigned for them.
406 407 408 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 406 def assignment_activity_sid @properties['assignment_activity_sid'] end |
#context ⇒ TaskQueueContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
391 392 393 394 395 396 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 391 def context unless @instance_context @instance_context = TaskQueueContext.new(@version, @params['workspace_sid'], @params['sid'], ) end @instance_context end |
#cumulative_statistics ⇒ cumulative_statistics
Access the cumulative_statistics
551 552 553 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 551 def cumulative_statistics context.cumulative_statistics end |
#date_created ⇒ Time
Returns The RFC 2822 date and time in GMT when the resource was created.
418 419 420 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 418 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The RFC 2822 date and time in GMT when the resource was last updated.
424 425 426 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 424 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the TaskQueueInstance
530 531 532 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 530 def delete context.delete end |
#fetch ⇒ TaskQueueInstance
Fetch the TaskQueueInstance
491 492 493 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 491 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
430 431 432 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 430 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
564 565 566 567 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 564 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.TaskQueueInstance #{values}>" end |
#links ⇒ String
Returns The URLs of related resources.
484 485 486 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 484 def links @properties['links'] end |
#max_reserved_workers ⇒ String
Returns The maximum number of Workers to reserve.
436 437 438 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 436 def max_reserved_workers @properties['max_reserved_workers'] end |
#real_time_statistics ⇒ real_time_statistics
Access the real_time_statistics
544 545 546 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 544 def real_time_statistics context.real_time_statistics end |
#reservation_activity_name ⇒ String
Returns The name of the Activity to assign Workers once a task is reserved for them.
448 449 450 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 448 def reservation_activity_name @properties['reservation_activity_name'] end |
#reservation_activity_sid ⇒ String
Returns The SID of the Activity to assign Workers once a task is reserved for them.
442 443 444 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 442 def reservation_activity_sid @properties['reservation_activity_sid'] end |
#sid ⇒ String
Returns The unique string that identifies the resource.
454 455 456 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 454 def sid @properties['sid'] end |
#statistics ⇒ statistics
Access the statistics
537 538 539 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 537 def statistics context.statistics end |
#target_workers ⇒ String
Returns A string describing the Worker selection criteria for any Tasks that enter the TaskQueue.
460 461 462 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 460 def target_workers @properties['target_workers'] end |
#task_order ⇒ task_queue.TaskOrder
Returns How Tasks will be assigned to Workers.
466 467 468 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 466 def task_order @properties['task_order'] end |
#to_s ⇒ Object
Provide a user friendly representation
557 558 559 560 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 557 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.TaskQueueInstance #{values}>" end |
#update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset) ⇒ TaskQueueInstance
Update the TaskQueueInstance
516 517 518 519 520 521 522 523 524 525 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 516 def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset) context.update( friendly_name: friendly_name, target_workers: target_workers, reservation_activity_sid: reservation_activity_sid, assignment_activity_sid: assignment_activity_sid, max_reserved_workers: max_reserved_workers, task_order: task_order, ) end |
#url ⇒ String
Returns The absolute URL of the TaskQueue resource.
472 473 474 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 472 def url @properties['url'] end |
#workspace_sid ⇒ String
Returns The SID of the Workspace that contains the TaskQueue.
478 479 480 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 478 def workspace_sid @properties['workspace_sid'] end |