Constructor and Description |
---|
WorkerReader(String pathWorkspaceSid)
Construct a new WorkerReader.
|
Modifier and Type | Method and Description |
---|---|
Page<Worker> |
firstPage(TwilioRestClient client)
Make the request to the Twilio API to perform the read.
|
Page<Worker> |
getPage(String targetUrl,
TwilioRestClient client)
Retrieve the target page from the Twilio API.
|
Page<Worker> |
nextPage(Page<Worker> page,
TwilioRestClient client)
Retrieve the next page from the Twilio API.
|
Page<Worker> |
previousPage(Page<Worker> page,
TwilioRestClient client)
Retrieve the previous page from the Twilio API.
|
ResourceSet<Worker> |
read(TwilioRestClient client)
Make the request to the Twilio API to perform the read.
|
WorkerReader |
setActivityName(String activityName)
The `activity_name` of the Worker resources to read..
|
WorkerReader |
setActivitySid(String activitySid)
The `activity_sid` of the Worker resources to read..
|
WorkerReader |
setAvailable(String available)
Whether to return only Worker resources that are available or unavailable.
|
WorkerReader |
setFriendlyName(String friendlyName)
The `friendly_name` of the Worker resources to read..
|
WorkerReader |
setTargetWorkersExpression(String targetWorkersExpression)
Filter by Workers that would match an expression on a TaskQueue.
|
WorkerReader |
setTaskQueueName(String taskQueueName)
The `friendly_name` of the TaskQueue that the Workers to read are eligible
for..
|
WorkerReader |
setTaskQueueSid(String taskQueueSid)
The SID of the TaskQueue that the Workers to read are eligible for..
|
public WorkerReader(String pathWorkspaceSid)
pathWorkspaceSid
- The SID of the Workspace with the Workers to readpublic WorkerReader setActivityName(String activityName)
activityName
- The activity_name of the Worker resources to readpublic WorkerReader setActivitySid(String activitySid)
activitySid
- The activity_sid of the Worker resources to readpublic WorkerReader setAvailable(String available)
available
- Whether to return Worker resources that are available or
unavailablepublic WorkerReader setFriendlyName(String friendlyName)
friendlyName
- The friendly_name of the Worker resources to readpublic WorkerReader setTargetWorkersExpression(String targetWorkersExpression)
targetWorkersExpression
- Filter by Workers that would match an
expression on a TaskQueuepublic WorkerReader setTaskQueueName(String taskQueueName)
taskQueueName
- The friendly_name of the TaskQueue that the Workers to
read are eligible forpublic WorkerReader setTaskQueueSid(String taskQueueSid)
taskQueueSid
- The SID of the TaskQueue that the Workers to read are
eligible forpublic ResourceSet<Worker> read(TwilioRestClient client)
public Page<Worker> firstPage(TwilioRestClient client)
public Page<Worker> getPage(String targetUrl, TwilioRestClient client)
public Page<Worker> nextPage(Page<Worker> page, TwilioRestClient client)
public Page<Worker> previousPage(Page<Worker> page, TwilioRestClient client)
previousPage
in class Reader<Worker>
page
- current pageclient
- TwilioRestClient with which to make the requestCopyright © 2019 Twilio, Inc. All Rights Reserved.