com.twilio.rest.taskrouter.v1.workspace.TaskQueueReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Show all versions of twilio Show documentation
Twilio Java Helper Library
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.taskrouter.v1.workspace;
import com.twilio.base.Page;
import com.twilio.base.Reader;
import com.twilio.base.ResourceSet;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
public class TaskQueueReader extends Reader {
private final String pathWorkspaceSid;
private String friendlyName;
private String evaluateWorkerAttributes;
private String workerSid;
/**
* Construct a new TaskQueueReader.
*
* @param pathWorkspaceSid The workspace_sid
*/
public TaskQueueReader(final String pathWorkspaceSid) {
this.pathWorkspaceSid = pathWorkspaceSid;
}
/**
* Filter by a human readable description of a TaskQueue (for example "Customer
* Support" or "2014 Election Campaign").
*
* @param friendlyName Filter by a human readable description of a TaskQueue
* @return this
*/
public TaskQueueReader setFriendlyName(final String friendlyName) {
this.friendlyName = friendlyName;
return this;
}
/**
* Provide a Worker attributes expression, and this will return the list of
* TaskQueues that would distribute tasks to a worker with these attributes..
*
* @param evaluateWorkerAttributes Provide a Worker attributes expression, and
* this will return the list of TaskQueues that
* would distribute tasks to a worker with these
* attributes.
* @return this
*/
public TaskQueueReader setEvaluateWorkerAttributes(final String evaluateWorkerAttributes) {
this.evaluateWorkerAttributes = evaluateWorkerAttributes;
return this;
}
/**
* The worker_sid.
*
* @param workerSid The worker_sid
* @return this
*/
public TaskQueueReader setWorkerSid(final String workerSid) {
this.workerSid = workerSid;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return TaskQueue ResourceSet
*/
@Override
public ResourceSet read(final TwilioRestClient client) {
return new ResourceSet<>(this, client, firstPage(client));
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return TaskQueue ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page firstPage(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
Domains.TASKROUTER.toString(),
"/v1/Workspaces/" + this.pathWorkspaceSid + "/TaskQueues",
client.getRegion()
);
addQueryParams(request);
return pageForRequest(client, request);
}
/**
* Retrieve the target page from the Twilio API.
*
* @param targetUrl API-generated URL for the requested results page
* @param client TwilioRestClient with which to make the request
* @return TaskQueue ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page getPage(final String targetUrl, final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
targetUrl
);
return pageForRequest(client, request);
}
/**
* Retrieve the next page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Next Page
*/
@Override
public Page nextPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getNextPageUrl(
Domains.TASKROUTER.toString(),
client.getRegion()
)
);
return pageForRequest(client, request);
}
/**
* Retrieve the previous page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Previous Page
*/
@Override
public Page previousPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getPreviousPageUrl(
Domains.TASKROUTER.toString(),
client.getRegion()
)
);
return pageForRequest(client, request);
}
/**
* Generate a Page of TaskQueue Resources for a given request.
*
* @param client TwilioRestClient with which to make the request
* @param request Request to generate a page for
* @return Page for the Request
*/
private Page pageForRequest(final TwilioRestClient client, final Request request) {
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("TaskQueue read failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.apply(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(
restException.getMessage(),
restException.getCode(),
restException.getMoreInfo(),
restException.getStatus(),
null
);
}
return Page.fromJson(
"task_queues",
response.getContent(),
TaskQueue.class,
client.getObjectMapper()
);
}
/**
* Add the requested query string arguments to the Request.
*
* @param request Request to add query string arguments to
*/
private void addQueryParams(final Request request) {
if (friendlyName != null) {
request.addQueryParam("FriendlyName", friendlyName);
}
if (evaluateWorkerAttributes != null) {
request.addQueryParam("EvaluateWorkerAttributes", evaluateWorkerAttributes);
}
if (workerSid != null) {
request.addQueryParam("WorkerSid", workerSid);
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}