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](www.twilio.com/docs/iam/api/account) that created the TaskQueue 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 date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#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 ⇒ Hash
The URLs of related resources.
-
#max_reserved_workers ⇒ String
The maximum number of Workers to reserve for the assignment of a task in the queue.
-
#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 we created to identify the TaskQueue 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 ⇒ TaskOrder
-
#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
359 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 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 359 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'] == nil ? payload['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 || @properties['workspace_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
399 400 401 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 399 def account_sid @properties['account_sid'] end |
#assignment_activity_name ⇒ String
411 412 413 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 411 def assignment_activity_name @properties['assignment_activity_name'] end |
#assignment_activity_sid ⇒ String
405 406 407 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 405 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
390 391 392 393 394 395 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 390 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
534 535 536 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 534 def cumulative_statistics context.cumulative_statistics end |
#date_created ⇒ Time
417 418 419 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 417 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
423 424 425 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 423 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the TaskQueueInstance
490 491 492 493 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 490 def delete context.delete end |
#fetch ⇒ TaskQueueInstance
Fetch the TaskQueueInstance
498 499 500 501 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 498 def fetch context.fetch end |
#friendly_name ⇒ String
429 430 431 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 429 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
561 562 563 564 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 561 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.TaskQueueInstance #{values}>" end |
#links ⇒ Hash
483 484 485 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 483 def links @properties['links'] end |
#max_reserved_workers ⇒ String
435 436 437 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 435 def max_reserved_workers @properties['max_reserved_workers'] end |
#real_time_statistics ⇒ real_time_statistics
Access the real_time_statistics
548 549 550 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 548 def real_time_statistics context.real_time_statistics end |
#reservation_activity_name ⇒ String
447 448 449 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 447 def reservation_activity_name @properties['reservation_activity_name'] end |
#reservation_activity_sid ⇒ String
441 442 443 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 441 def reservation_activity_sid @properties['reservation_activity_sid'] end |
#sid ⇒ String
453 454 455 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 453 def sid @properties['sid'] end |
#statistics ⇒ statistics
Access the statistics
541 542 543 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 541 def statistics context.statistics end |
#target_workers ⇒ String
459 460 461 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 459 def target_workers @properties['target_workers'] end |
#task_order ⇒ TaskOrder
465 466 467 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 465 def task_order @properties['task_order'] end |
#to_s ⇒ Object
Provide a user friendly representation
554 555 556 557 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 554 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
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 512 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
471 472 473 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 471 def url @properties['url'] end |
#workspace_sid ⇒ String
477 478 479 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 477 def workspace_sid @properties['workspace_sid'] end |