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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The workspace_sid



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

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.

Parameters:

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

    The friendly_name

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

    The activity_sid

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

    The attributes

Returns:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 169

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.



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

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of WorkerInstance



154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 154

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.

Parameters:

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

    The activity_name

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

    The activity_sid

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

    The available

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

    The friendly_name

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

    The target_workers_expression

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

    The task_queue_name

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

    The task_queue_sid

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 49

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.

Parameters:

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

    The activity_name

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

    The activity_sid

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

    The available

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

    The friendly_name

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

    The target_workers_expression

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

    The task_queue_name

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

    The task_queue_sid

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of WorkerInstance



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 128

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

Returns:



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 193

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.

Parameters:

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

    The activity_name

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

    The activity_sid

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

    The available

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

    The friendly_name

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

    The target_workers_expression

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

    The task_queue_name

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

    The task_queue_sid

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 81

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



207
208
209
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 207

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