com.twilio.rest.wireless.v1.sim.UsageRecordReader 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.wireless.v1.sim;
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 java.time.ZonedDateTime;
public class UsageRecordReader extends Reader {
private final String pathSimSid;
private ZonedDateTime end;
private ZonedDateTime start;
private UsageRecord.Granularity granularity;
/**
* Construct a new UsageRecordReader.
*
* @param pathSimSid The SID of the Sim resource to read the usage from
*/
public UsageRecordReader(final String pathSimSid) {
this.pathSimSid = pathSimSid;
}
/**
* Only include usage that occurred on or before this date, specified in ISO 8601.
* The default is the current time..
*
* @param end Only include usage that occurred on or before this date
* @return this
*/
public UsageRecordReader setEnd(final ZonedDateTime end) {
this.end = end;
return this;
}
/**
* Only include usage that has occurred on or after this date, specified in ISO 8601.
* The default is one month before the `end` parameter value..
*
* @param start Only include usage that has occurred on or after this date
* @return this
*/
public UsageRecordReader setStart(final ZonedDateTime start) {
this.start = start;
return this;
}
/**
* How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. The
* default is `all`. A value of `all` returns one Usage Record that describes
* the usage for the entire period..
*
* @param granularity The time-based grouping that results are aggregated by
* @return this
*/
public UsageRecordReader setGranularity(final UsageRecord.Granularity granularity) {
this.granularity = granularity;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return UsageRecord 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 UsageRecord ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page firstPage(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
Domains.WIRELESS.toString(),
"/v1/Sims/" + this.pathSimSid + "/UsageRecords"
);
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 UsageRecord 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.WIRELESS.toString())
);
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.WIRELESS.toString())
);
return pageForRequest(client, request);
}
/**
* Generate a Page of UsageRecord 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("UsageRecord read 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 Page.fromJson(
"usage_records",
response.getContent(),
UsageRecord.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 (end != null) {
request.addQueryParam("End", end.toString());
}
if (start != null) {
request.addQueryParam("Start", start.toString());
}
if (granularity != null) {
request.addQueryParam("Granularity", granularity.toString());
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}