Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb

Defined Under Namespace

Classes: WorkersStatisticsContext, WorkersStatisticsInstance, WorkersStatisticsList, WorkersStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ WorkerList

Initialize the WorkerList



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 21

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

  # Path Solution
  @solution = {workspace_sid: workspace_sid}
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers"

  # Components
  @statistics = nil
end

Instance Method Details

#create(friendly_name: nil, activity_sid: :unset, attributes: :unset) ⇒ WorkerInstance

Retrieve a single page of WorkerInstance records from the API. Request is executed immediately.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 198

def create(friendly_name: nil, activity_sid: :unset, attributes: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'ActivitySid' => activity_sid,
      'Attributes' => attributes,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
end

#each ⇒ Object

When passed a block, yields WorkerInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 119

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of WorkerInstance records from the API. Request is executed immediately.



177
178
179
180
181
182
183
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 177

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  WorkerPage.new(@version, response, @solution)
end

#list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, limit: nil, page_size: nil) ⇒ Array

Lists WorkerInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 58

def list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, limit: nil, page_size: nil)
  self.stream(
      activity_name: activity_name,
      activity_sid: activity_sid,
      available: available,
      friendly_name: friendly_name,
      target_workers_expression: target_workers_expression,
      task_queue_name: task_queue_name,
      task_queue_sid: task_queue_sid,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of WorkerInstance records from the API. Request is executed immediately.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 151

def page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'ActivityName' => activity_name,
      'ActivitySid' => activity_sid,
      'Available' => available,
      'FriendlyName' => friendly_name,
      'TargetWorkersExpression' => target_workers_expression,
      'TaskQueueName' => task_queue_name,
      'TaskQueueSid' => task_queue_sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  WorkerPage.new(@version, response, @solution)
end

#statistics ⇒ WorkersStatisticsList, WorkersStatisticsContext

Access the statistics



218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 218

def statistics
  return WorkersStatisticsContext.new(@version, @solution[:workspace_sid], )

  @statistics ||= WorkersStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid], )
end

#stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams WorkerInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 98

def stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      activity_name: activity_name,
      activity_sid: activity_sid,
      available: available,
      friendly_name: friendly_name,
      target_workers_expression: target_workers_expression,
      task_queue_name: task_queue_name,
      task_queue_sid: task_queue_sid,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  '#<Twilio.Taskrouter.V1.WorkerList>'
end