com.twilio.sdk.reader.api.v2010.account.usage

Class RecordReader

java.lang.Object

com.twilio.sdk.reader.Reader<Record>

com.twilio.sdk.reader.api.v2010.account.usage.RecordReader

public class RecordReader
extends Reader<Record>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RecordReader	byCategory(Record.Category category) Only include usage of a given category.
RecordReader	byEndDate(String endDate) Only include usage that has occurred on or after this date.
RecordReader	byStartDate(String startDate) Only include usage that has occurred on or after this date.
ResourceSet<Record>	execute(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Record>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Record>	nextPage(Page<Record> page, TwilioRestClient client) Retrieve the next page from the Twilio API.

Methods inherited from class com.twilio.sdk.reader.Reader

async, async, execute, firstPage, getPageSize, nextPage, pageSize

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordReader

public RecordReader(String accountSid)

Construct a new RecordReader.

Parameters:

accountSid - The account_sid

Method Detail

byCategory

public RecordReader byCategory(Record.Category category)

Only include usage of a given category.

Parameters:

category - Only include usage of a given category

Returns:

this

byStartDate

public RecordReader byStartDate(String 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

byEndDate

public RecordReader byEndDate(String 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

execute

public ResourceSet<Record> execute(TwilioRestClient client)

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

Specified by:

execute 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

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