com.twilio.rest.supersim.v1.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.supersim.v1;
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;
/**
* PLEASE NOTE that this class contains preview products that are subject to
* change. Use them with caution. If you currently do not have developer preview
* access, please contact [email protected].
*/
public class UsageRecordReader extends Reader {
private String sim;
private String fleet;
private String network;
private String isoCountry;
private UsageRecord.Group group;
private UsageRecord.Granularity granularity;
private ZonedDateTime startTime;
private ZonedDateTime endTime;
/**
* SID or unique name of a Sim resource. Only show UsageRecords representing
* usage incurred by this Super SIM..
*
* @param sim SID or unique name of a Sim resource. Only show UsageRecords
* representing usage incurred by this Super SIM.
* @return this
*/
public UsageRecordReader setSim(final String sim) {
this.sim = sim;
return this;
}
/**
* SID or unique name of a Fleet resource. Only show UsageRecords representing
* usage for Super SIMs belonging to this Fleet resource at the time the usage
* occurred..
*
* @param fleet SID or unique name of a Fleet resource. Only show UsageRecords
* representing usage for Super SIMs belonging to this Fleet
* resource at the time the usage occurred.
* @return this
*/
public UsageRecordReader setFleet(final String fleet) {
this.fleet = fleet;
return this;
}
/**
* SID of a Network resource. Only show UsageRecords representing usage on this
* network..
*
* @param network SID of a Network resource. Only show UsageRecords
* representing usage on this network.
* @return this
*/
public UsageRecordReader setNetwork(final String network) {
this.network = network;
return this;
}
/**
* Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this
* country..
*
* @param isoCountry Alpha-2 ISO Country Code. Only show UsageRecords
* representing usage in this country.
* @return this
*/
public UsageRecordReader setIsoCountry(final String isoCountry) {
this.isoCountry = isoCountry;
return this;
}
/**
* Dimension over which to aggregate usage records. Can be: `sim`, `fleet`,
* `network`, `isoCountry`. Default is to not aggregate across any of these
* dimensions, UsageRecords will be aggregated into the time buckets described
* by the `Granularity` parameter..
*
* @param group Dimension over which to aggregate usage records.
* @return this
*/
public UsageRecordReader setGroup(final UsageRecord.Group group) {
this.group = group;
return this;
}
/**
* Time-based grouping that UsageRecords should be aggregated by. Can be:
* `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that
* describes the usage for the entire period..
*
* @param granularity Time-based grouping that UsageRecords should be
* aggregated by. Can be: `hour`, `day`, or `all`. Default is
* `all`.
* @return this
*/
public UsageRecordReader setGranularity(final UsageRecord.Granularity granularity) {
this.granularity = granularity;
return this;
}
/**
* Only include usage that occurred at or after this time, specified in ISO 8601 format. Default is
* one month before the `end_time`..
*
* @param startTime Only include usage that occurred at or after this time.
* @return this
*/
public UsageRecordReader setStartTime(final ZonedDateTime startTime) {
this.startTime = startTime;
return this;
}
/**
* Only include usage that occurred before this time, specified in ISO 8601 format. Default is
* the current time..
*
* @param endTime Only include usage that occurred before this time.
* @return this
*/
public UsageRecordReader setEndTime(final ZonedDateTime endTime) {
this.endTime = endTime;
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.SUPERSIM.toString(),
"/v1/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.SUPERSIM.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.SUPERSIM.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 (sim != null) {
request.addQueryParam("Sim", sim.toString());
}
if (fleet != null) {
request.addQueryParam("Fleet", fleet.toString());
}
if (network != null) {
request.addQueryParam("Network", network);
}
if (isoCountry != null) {
request.addQueryParam("IsoCountry", isoCountry);
}
if (group != null) {
request.addQueryParam("Group", group.toString());
}
if (granularity != null) {
request.addQueryParam("Granularity", granularity.toString());
}
if (startTime != null) {
request.addQueryParam("StartTime", startTime.toString());
}
if (endTime != null) {
request.addQueryParam("EndTime", endTime.toString());
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}