Package com.twilio.base

Class Reader<T extends Resource>

java.lang.Object

com.twilio.base.Reader<T>

Type Parameters:

T - type of the resource

Direct Known Subclasses:

AccountReader, ActivityReader, AddOnResultReader, AddressConfigurationReader, AddressReader, AlertReader, AllTimeReader, AlphaSenderReader, ApplicationReader, AppReader, AssetReader, AssetVersionReader, AssignedAddOnExtensionReader, AssignedAddOnReader, AssistantReader, AssistantReader, AuthCallsCredentialListMappingReader, AuthCallsIpAccessControlListMappingReader, AuthorizationDocumentReader, AuthorizedConnectAppReader, AuthRegistrationsCredentialListMappingReader, AvailableAddOnExtensionReader, AvailableAddOnReader, AvailablePhoneNumberCountryReader, AwsReader, BillingPeriodReader, BindingReader, BindingReader, BindingReader, BindingReader, BrandRegistrationReader, BrandVettingReader, BucketReader, BuildReader, BundleCopyReader, BundleReader, ByocTrunkReader, CallReader, CallSummariesReader, CertificateReader, ChallengeReader, ChannelReader, ChannelReader, ChannelReader, ChannelReader, ChannelReader, CommandReader, CommandReader, CompositionHookReader, CompositionReader, ConferenceParticipantReader, ConferenceReader, ConferenceReader, ConnectAppReader, ConnectionPolicyReader, ConnectionPolicyTargetReader, ContentReader, ConversationReader, ConversationReader, CountryReader, CountryReader, CountryReader, CountryReader, CountryReader, CountryReader, CredentialListMappingReader, CredentialListReader, CredentialListReader, CredentialReader, CredentialReader, CredentialReader, CredentialReader, CredentialReader, CredentialReader, CredentialReader, CustomerProfilesChannelEndpointAssignmentReader, CustomerProfilesEntityAssignmentsReader, CustomerProfilesEvaluationsReader, CustomerProfilesReader, DailyReader, DataSessionReader, DayReader, DeliveryReceiptReader, DeliveryReceiptReader, DependentHostedNumberOrderReader, DependentPhoneNumberReader, DeploymentReader, DeploymentReader, DeviceReader, DeviceReader, DocumentPermissionReader, DocumentPermissionReader, DocumentReader, DocumentReader, DomainReader, EndUserReader, EndUserReader, EndUserTypeReader, EndUserTypeReader, EngagementReader, EntityReader, EnvironmentReader, EsimProfileReader, EvaluationReader, EventReader, EventReader, EventReader, EventReader, EventTypeReader, ExecutionReader, ExecutionReader, ExecutionStepReader, ExecutionStepReader, ExportCustomJobReader, FactorReader, FieldReader, FieldReader, FieldTypeReader, FieldTypeReader, FieldValueReader, FieldValueReader, FleetReader, FleetReader, FlexFlowReader, FlowReader, FlowReader, FlowRevisionReader, FunctionReader, FunctionVersionReader, HighriskSpecialPrefixReader, HostedNumberOrderReader, IncomingPhoneNumberReader, InstalledAddOnExtensionReader, InstalledAddOnReader, InteractionChannelInviteReader, InteractionChannelParticipantReader, InteractionChannelReader, InteractionReader, InviteReader, InviteReader, InviteReader, InviteReader, IpAccessControlListMappingReader, IpAccessControlListReader, IpAccessControlListReader, IpAddressReader, IpCommandReader, IpRecordReader, ItemAssignmentReader, KeyReader, KeyReader, LastMonthReader, LocalReader, LocalReader, LogReader, MachineToMachineReader, MediaProcessorReader, MediaReader, MediaRecordingReader, MemberReader, MemberReader, MemberReader, MemberReader, MemberReader, MessageInteractionReader, MessageReader, MessageReader, MessageReader, MessageReader, MessageReader, MessageReader, MessageReader, MessagingConfigurationReader, MetricReader, MobileReader, MobileReader, ModelBuildReader, ModelBuildReader, MonthlyReader, NationalReader, NetworkAccessProfileNetworkReader, NetworkAccessProfileReader, NetworkReader, NotificationReader, NotificationReader, OriginationUrlReader, OutgoingCallerIdReader, ParticipantConversationReader, ParticipantConversationReader, ParticipantReader, ParticipantReader, ParticipantReader, ParticipantReader, ParticipantReader, ParticipantReader, PayloadReader, PhoneNumberReader, PhoneNumberReader, PhoneNumberReader, PlayerStreamerReader, PoliciesReader, PublicKeyReader, PublishedTrackReader, QueryReader, QueryReader, QueueReader, RateLimitReader, RatePlanReader, RatePlanReader, RecordingReader, RecordingReader, RecordingReader, RecordingReader, RecordReader, RegulationReader, ReservationReader, ReservationReader, RoleReader, RoleReader, RoleReader, RoleReader, RoleReader, RoleReader, RoomReader, RoomReader, RoomRecordingReader, SampleReader, SampleReader, SchemaVersionReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, ServiceReader, SessionReader, SettingsUpdateReader, SharedCostReader, ShortCodeReader, ShortCodeReader, ShortCodeReader, SigningKeyReader, SimIpAddressReader, SimReader, SimReader, SimReader, SinkReader, SmsCommandReader, SourceIpMappingReader, StepReader, SubscribedEventReader, SubscribedTrackReader, SubscriptionReader, SupportingDocumentReader, SupportingDocumentReader, SupportingDocumentTypeReader, SupportingDocumentTypeReader, SyncListItemReader, SyncListItemReader, SyncListPermissionReader, SyncListPermissionReader, SyncListReader, SyncListReader, SyncMapItemReader, SyncMapItemReader, SyncMapPermissionReader, SyncMapPermissionReader, SyncMapReader, SyncMapReader, SyncStreamReader, TaskChannelReader, TaskQueueReader, TaskQueuesStatisticsReader, TaskReader, TaskReader, TaskReader, TemplateReader, ThisMonthReader, TodayReader, TollFreeReader, TollFreeReader, TollfreeVerificationReader, TranscriptionReader, TranscriptionReader, TriggerReader, TrunkReader, TrustProductsChannelEndpointAssignmentReader, TrustProductsEntityAssignmentsReader, TrustProductsEvaluationsReader, TrustProductsReader, UsageRecordReader, UsageRecordReader, UsageRecordReader, UsAppToPersonReader, UserBindingReader, UserBindingReader, UserChannelReader, UserChannelReader, UserChannelReader, UserChannelReader, UserConversationReader, UserConversationReader, UserReader, UserReader, UserReader, UserReader, UserReader, UserReader, VariableReader, VerificationAttemptReader, VoipReader, WebChannelReader, WebhookReader, WebhookReader, WebhookReader, WebhookReader, WebhookReader, WebhookReader, WorkerChannelReader, WorkerReader, WorkflowReader, WorkspaceReader, YearlyReader, YesterdayReader

public abstract class Reader<T extends Resource>
extends Object

Executor for listing of a resource.

Constructor Summary

Constructors

Constructor	Description
Reader()

Method Summary

Modifier and Type	Method	Description
Page<T>	firstPage()	Fetch the first page of resources.
abstract Page<T>	firstPage(TwilioRestClient client)	Fetch the first page of resources using specified client.
Long	getLimit()
Page<T>	getPage(String targetUrl)	Retrieve the target page of resources.
abstract Page<T>	getPage(String targetUrl, TwilioRestClient client)	Retrieve the target page of resources.
Integer	getPageSize()
Reader<T>	limit(long limit)	Sets the max number of records to read.
Page<T>	nextPage(Page<T> page)	Fetch the following page of resources.
abstract Page<T>	nextPage(Page<T> page, TwilioRestClient client)	Fetch the following page of resources using specified client.
Reader<T>	pageSize(int pageSize)
Page<T>	previousPage(Page<T> page)	Fetch the prior page of resources.
abstract Page<T>	previousPage(Page<T> page, TwilioRestClient client)	Fetch the prior page of resources using specified client.
ResourceSet<T>	read()	Execute a request using default client.
abstract ResourceSet<T>	read(TwilioRestClient client)	Execute a request using specified client.
CompletableFuture<ResourceSet<T>>	readAsync()	Execute an async request using default client.
CompletableFuture<ResourceSet<T>>	readAsync(TwilioRestClient client)	Execute an async request using specified client.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reader

public Reader()

Method Detail

read

public ResourceSet<T> read()

Execute a request using default client.

Returns:

ResourceSet of objects

read

public abstract ResourceSet<T> read(TwilioRestClient client)

Execute a request using specified client.

Parameters:

client - client used to make request

Returns:

ResourceSet of objects

readAsync

public CompletableFuture<ResourceSet<T>> readAsync()

Execute an async request using default client.

Returns:

future that resolves to the ResourceSet of objects

readAsync

public CompletableFuture<ResourceSet<T>> readAsync(TwilioRestClient client)

Execute an async request using specified client.

Parameters:

client - client used to make request

Returns:

future that resolves to the ResourceSet of objects

firstPage

public Page<T> firstPage()

Fetch the first page of resources.

Returns:

Page containing the first pageSize of resources

firstPage

public abstract Page<T> firstPage(TwilioRestClient client)

Fetch the first page of resources using specified client.

Parameters:

client - client used to fetch

Returns:

Page containing the first pageSize of resources

getPage

public Page<T> getPage(String targetUrl)

Retrieve the target page of resources.

Parameters:

targetUrl - API-generated URL for the requested results page

Returns:

Page containing the target pageSize of resources

getPage

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

Retrieve the target page of resources.

Parameters:

targetUrl - API-generated URL for the requested results page

client - client used to fetch

Returns:

Page containing the target pageSize of resources

nextPage

public Page<T> nextPage(Page<T> page)

Fetch the following page of resources.

Parameters:

page - current page of resources

Returns:

Page containing the next pageSize of resources

nextPage

public abstract Page<T> nextPage(Page<T> page,
                                 TwilioRestClient client)

Fetch the following page of resources using specified client.

Parameters:

page - current page of resources

client - client used to fetch

Returns:

Page containing the next pageSize of resources

previousPage

public Page<T> previousPage(Page<T> page)

Fetch the prior page of resources.

Parameters:

page - current page of resources

Returns:

Page containing the previous pageSize of resources

previousPage

public abstract Page<T> previousPage(Page<T> page,
                                     TwilioRestClient client)

Fetch the prior page of resources using specified client.

Parameters:

page - current page of resources

client - client used to fetch

Returns:

Page containing the previous pageSize of resources

getPageSize

public Integer getPageSize()

pageSize

public Reader<T> pageSize(int pageSize)

getLimit

public Long getLimit()

limit

public Reader<T> limit(long limit)

Sets the max number of records to read.

Parameters:

limit - max number of records to read

Returns:

this reader