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

Class AllTimeReader

java.lang.Object

com.twilio.base.Reader<AllTime>

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

public class AllTimeReader
extends Reader<AllTime>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Page<AllTime>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<AllTime>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<AllTime>	nextPage(Page<AllTime> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<AllTime>	previousPage(Page<AllTime> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<AllTime>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
AllTimeReader	setCategory(AllTime.Category category) The usage category of the UsageRecord resources to read.
AllTimeReader	setEndDate(LocalDate endDate) Only include usage that occurred on or before this date.
AllTimeReader	setIncludeSubaccounts(Boolean includeSubaccounts) Whether to include usage from the master account and all its subaccounts.
AllTimeReader	setStartDate(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

AllTimeReader

public AllTimeReader()

Construct a new AllTimeReader.

AllTimeReader

public AllTimeReader(String pathAccountSid)

Construct a new AllTimeReader.

Parameters:

pathAccountSid - The SID of the Account that created the resources to read

Method Detail

setCategory

public AllTimeReader setCategory(AllTime.Category category)

The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved..

Parameters:

category - The usage category of the UsageRecord resources to read

Returns:

this

setStartDate

public AllTimeReader setStartDate(LocalDate startDate)

Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date..

Parameters:

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

Returns:

this

setEndDate

public AllTimeReader setEndDate(LocalDate endDate)

Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date..

Parameters:

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

Returns:

this

setIncludeSubaccounts

public AllTimeReader setIncludeSubaccounts(Boolean includeSubaccounts)

Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account..

Parameters:

includeSubaccounts - Whether to include usage from the master account and all its subaccounts

Returns:

this

read

public ResourceSet<AllTime> read(TwilioRestClient client)

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

Specified by:

read in class Reader<AllTime>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

AllTime ResourceSet

firstPage

public Page<AllTime> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<AllTime>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

AllTime ResourceSet

getPage

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

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<AllTime>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

AllTime ResourceSet

nextPage

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

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<AllTime>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

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

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<AllTime>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page