com.twilio.rest.api.v2010.account.usage

Class RecordReader

java.lang.Object

com.twilio.base.Reader<Record>

com.twilio.rest.api.v2010.account.usage.RecordReader

public class RecordReader
extends Reader<Record>

Constructor Summary

Constructors

Constructor and Description
RecordReader() Construct a new RecordReader.
RecordReader(String pathAccountSid) Construct a new RecordReader.

Method Summary

Modifier and Type	Method and Description
Page<Record>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Record>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Record>	nextPage(Page<Record> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Record>	previousPage(Page<Record> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Record>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
RecordReader	setCategory(Record.Category category) Only include usage of a given category.
RecordReader	setEndDate(org.joda.time.LocalDate endDate) Only include usage that has occurred on or after this date.
RecordReader	setStartDate(org.joda.time.LocalDate startDate) Only include usage that has occurred on or after this date.

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

RecordReader

public RecordReader()

Construct a new RecordReader.

RecordReader

public RecordReader(String pathAccountSid)

Construct a new RecordReader.

Parameters:

pathAccountSid - The account_sid

Method Detail

setCategory

public RecordReader setCategory(Record.Category category)

Only include usage of a given category.

Parameters:

category - Only include usage of a given category

Returns:

this

setStartDate

public RecordReader setStartDate(org.joda.time.LocalDate startDate)

Only include usage that has occurred on or after this date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify offsets to today, for example, StartDate=-30days, which will make StartDate 30 days before today.

Parameters:

startDate - Filter by start date

Returns:

this

setEndDate

public RecordReader setEndDate(org.joda.time.LocalDate endDate)

Only include usage that has occurred on or after this date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify offsets to today, for example, EndDate=+30days, which will make EndDate 30 days from today.

Parameters:

endDate - Filter by end date

Returns:

this

read

public ResourceSet<Record> read(TwilioRestClient client)

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

Specified by:

read in class Reader<Record>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Record ResourceSet

firstPage

public Page<Record> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<Record>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Record ResourceSet

getPage

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

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Record>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Record ResourceSet

nextPage

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

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Record>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

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

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Record>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page