com.twilio.rest.taskrouter.v1.workspace.taskqueue.TaskQueueStatisticsFetcher 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.taskqueue;
import com.twilio.base.Fetcher;
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 java.time.ZonedDateTime;
public class TaskQueueStatisticsFetcher extends Fetcher {
private final String pathWorkspaceSid;
private final String pathTaskQueueSid;
private ZonedDateTime endDate;
private Integer minutes;
private ZonedDateTime startDate;
private String taskChannel;
private String splitByWaitTime;
/**
* Construct a new TaskQueueStatisticsFetcher.
*
* @param pathWorkspaceSid The SID of the Workspace with the TaskQueue to fetch
* @param pathTaskQueueSid The SID of the TaskQueue for which to fetch
* statistics
*/
public TaskQueueStatisticsFetcher(final String pathWorkspaceSid,
final String pathTaskQueueSid) {
this.pathWorkspaceSid = pathWorkspaceSid;
this.pathTaskQueueSid = pathTaskQueueSid;
}
/**
* Only calculate statistics from this date and time and earlier, specified in
* GMT as an ISO 8601
* date-time..
*
* @param endDate Only calculate statistics from on or before this date
* @return this
*/
public TaskQueueStatisticsFetcher setEndDate(final ZonedDateTime endDate) {
this.endDate = endDate;
return this;
}
/**
* Only calculate statistics since this many minutes in the past. The default is
* 15 minutes..
*
* @param minutes Only calculate statistics since this many minutes in the past
* @return this
*/
public TaskQueueStatisticsFetcher setMinutes(final Integer minutes) {
this.minutes = minutes;
return this;
}
/**
* Only calculate statistics from this date and time and later, specified in ISO 8601 format..
*
* @param startDate Only calculate statistics from on or after this date
* @return this
*/
public TaskQueueStatisticsFetcher setStartDate(final ZonedDateTime startDate) {
this.startDate = startDate;
return this;
}
/**
* Only calculate real-time and cumulative statistics for the specified
* TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as
* `voice`, `sms`, or `default`..
*
* @param taskChannel Only calculate real-time and cumulative statistics for
* the specified TaskChannel
* @return this
*/
public TaskQueueStatisticsFetcher setTaskChannel(final String taskChannel) {
this.taskChannel = taskChannel;
return this;
}
/**
* A comma separated list of values that describes the thresholds, in seconds,
* to calculate statistics on. For each threshold specified, the number of Tasks
* canceled and reservations accepted above and below the specified thresholds
* in seconds are computed..
*
* @param splitByWaitTime A comma separated list of values that describes the
* thresholds to calculate statistics on
* @return this
*/
public TaskQueueStatisticsFetcher setSplitByWaitTime(final String splitByWaitTime) {
this.splitByWaitTime = splitByWaitTime;
return this;
}
/**
* Make the request to the Twilio API to perform the fetch.
*
* @param client TwilioRestClient with which to make the request
* @return Fetched TaskQueueStatistics
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public TaskQueueStatistics fetch(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
Domains.TASKROUTER.toString(),
"/v1/Workspaces/" + this.pathWorkspaceSid + "/TaskQueues/" + this.pathTaskQueueSid + "/Statistics"
);
addQueryParams(request);
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("TaskQueueStatistics fetch failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.test(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(restException);
}
return TaskQueueStatistics.fromJson(response.getStream(), 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 (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);
}
}
}