com.twilio.rest.wireless.v1.sim

Class UsageRecordReader

java.lang.Object

com.twilio.base.Reader<UsageRecord>

com.twilio.rest.wireless.v1.sim.UsageRecordReader

public class UsageRecordReader
extends Reader<UsageRecord>

Constructor Summary

Constructors

Constructor and Description
UsageRecordReader(String pathSimSid) Construct a new UsageRecordReader.

Method Summary

Modifier and Type	Method and Description
Page<UsageRecord>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<UsageRecord>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<UsageRecord>	nextPage(Page<UsageRecord> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<UsageRecord>	previousPage(Page<UsageRecord> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<UsageRecord>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
UsageRecordReader	setEnd(org.joda.time.DateTime end) Only include usage that occurred on or before this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).
UsageRecordReader	setGranularity(UsageRecord.Granularity granularity) How to summarize the usage by time.
UsageRecordReader	setStart(org.joda.time.DateTime start) Only include usage that has occurred on or after this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).

Methods inherited from class com.twilio.base.Reader

firstPage, getLimit, getPage, getPageSize, limit, nextPage, pageSize, previousPage, read, readAsync, readAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsageRecordReader

public UsageRecordReader(String pathSimSid)

Construct a new UsageRecordReader.

Parameters:

pathSimSid - The SID of the Sim resource to read the usage from

Method Detail

setEnd

public UsageRecordReader setEnd(org.joda.time.DateTime end)

Only include usage that occurred on or before this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is the current time..

Parameters:

end - Only include usage that occurred on or before this date

Returns:

this

setStart

public UsageRecordReader setStart(org.joda.time.DateTime start)

Only include usage that has occurred on or after this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is one month before the `end` parameter value..

Parameters:

start - Only include usage that has occurred on or after this date

Returns:

this

setGranularity

public UsageRecordReader setGranularity(UsageRecord.Granularity granularity)

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..

Parameters:

granularity - The time-based grouping that results are aggregated by

Returns:

this

read

public ResourceSet<UsageRecord> read(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

read in class Reader<UsageRecord>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

UsageRecord ResourceSet

firstPage

public Page<UsageRecord> firstPage(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

firstPage in class Reader<UsageRecord>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

UsageRecord ResourceSet

getPage

public Page<UsageRecord> getPage(String targetUrl,
                                 TwilioRestClient client)

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<UsageRecord>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

UsageRecord ResourceSet

nextPage

public Page<UsageRecord> nextPage(Page<UsageRecord> page,
                                  TwilioRestClient client)

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<UsageRecord>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

public Page<UsageRecord> previousPage(Page<UsageRecord> page,
                                      TwilioRestClient client)

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<UsageRecord>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page