com.twilio.rest.taskrouter.v1.workspace.taskqueue.TaskQueuesStatisticsReader Maven / Gradle / Ivy
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.taskrouter.v1.workspace.taskqueue;
import com.twilio.base.Page;
import com.twilio.base.Reader;
import com.twilio.base.ResourceSet;
import com.twilio.converter.DateConverter;
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;
import org.joda.time.DateTime;
public class TaskQueuesStatisticsReader extends Reader {
private final String pathWorkspaceSid;
private DateTime endDate;
private String friendlyName;
private Integer minutes;
private DateTime startDate;
private String taskChannel;
private String splitByWaitTime;
/**
* Construct a new TaskQueuesStatisticsReader.
*
* @param pathWorkspaceSid The workspace_sid
*/
public TaskQueuesStatisticsReader(final String pathWorkspaceSid) {
this.pathWorkspaceSid = pathWorkspaceSid;
}
/**
* Filter cumulative statistics by an end date. This is helpful for defining a
* range of statistics to capture. Input is a GMT ISO 8601 Timestamp..
*
* @param endDate Filter cumulative statistics by an end date.
* @return this
*/
public TaskQueuesStatisticsReader setEndDate(final DateTime endDate) {
this.endDate = endDate;
return this;
}
/**
* Filter the TaskQueue stats based on a TaskQueue’s name (only for list
* resource).
*
* @param friendlyName Filter the TaskQueue stats based on a TaskQueue’s name
* @return this
*/
public TaskQueuesStatisticsReader setFriendlyName(final String friendlyName) {
this.friendlyName = friendlyName;
return this;
}
/**
* Filter cumulative statistics by up to ‘x’ minutes in the past. This is
* helpful for statistics for the last 15 minutes, 240 minutes (4 hours), and
* 480 minutes (8 hours) to see trends. Defaults to 15 minutes..
*
* @param minutes Filter cumulative statistics by up to ‘x’ minutes in the past.
* @return this
*/
public TaskQueuesStatisticsReader setMinutes(final Integer minutes) {
this.minutes = minutes;
return this;
}
/**
* Filter cumulative statistics by a start date. This is helpful for defining a
* range of statistics to capture. Input is a GMT ISO 8601 Timestamp..
*
* @param startDate Filter cumulative statistics by a start date.
* @return this
*/
public TaskQueuesStatisticsReader setStartDate(final DateTime startDate) {
this.startDate = startDate;
return this;
}
/**
* Filter real-time and cumulative statistics by TaskChannel. Takes in a Unique
* Name ("voice", "sms", "default", etc.) or a TaskChannelSid..
*
* @param taskChannel Filter real-time and cumulative statistics by TaskChannel.
* @return this
*/
public TaskQueuesStatisticsReader setTaskChannel(final String taskChannel) {
this.taskChannel = taskChannel;
return this;
}
/**
* A comma separated values for viewing splits of tasks canceled and accepted
* above the given threshold in seconds. Ex: "5,30" would show splits of tasks
* that were canceled or accepted before or after 5 seconds and respectively, 30
* seconds. This is great for showing short abandoned tasks or tasks that failed
* to meet your SLA..
*
* @param splitByWaitTime A comma separated values for viewing splits of tasks
* canceled and accepted above the given threshold in
* seconds.
* @return this
*/
public TaskQueuesStatisticsReader setSplitByWaitTime(final String splitByWaitTime) {
this.splitByWaitTime = splitByWaitTime;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return TaskQueuesStatistics 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 TaskQueuesStatistics 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/Statistics",
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 TaskQueuesStatistics 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 TaskQueuesStatistics 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("TaskQueuesStatistics 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_statistics",
response.getContent(),
TaskQueuesStatistics.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 (endDate != null) {
request.addQueryParam("EndDate", endDate.toString());
}
if (friendlyName != null) {
request.addQueryParam("FriendlyName", friendlyName);
}
if (minutes != null) {
request.addQueryParam("Minutes", minutes.toString());
}
if (startDate != null) {
request.addQueryParam("StartDate", startDate.toString());
}
if (taskChannel != null) {
request.addQueryParam("TaskChannel", taskChannel);
}
if (splitByWaitTime != null) {
request.addQueryParam("SplitByWaitTime", splitByWaitTime);
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy