@Generated(value="OracleSDKGenerator", comments="API Version: 20170907") public class EmailPaginators extends Object
Collection of helper methods that can be used to provide an Iterable
interface to any list operations of Email where multiple pages of data may be fetched. Two styles of iteration are supported:
These iterables abstract away the need to write code to manually handle pagination via looping and using the page tokens. They will automatically fetch more data from the service when required.
As an example, if we were using the ListUsers operation in IdentityService, then the Iterable
returned by calling a ResponseIterator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the Iterable
returned by calling a RecordIterator method would iterate over the User records and we don’t have to deal with ListUsersResponse objects at all. In either case, pagination will be automatically handled so we can iterate until there are no more responses or no more resources/records available.
Constructor and Description |
---|
EmailPaginators(Email client) |
Modifier and Type | Method and Description |
---|---|
Iterable<SenderSummary> |
listSendersRecordIterator(ListSendersRequest request)
Creates a new iterable which will iterate over the
SenderSummary objects contained in responses from the listSenders operation. |
Iterable<ListSendersResponse> |
listSendersResponseIterator(ListSendersRequest request)
Creates a new iterable which will iterate over the responses received from the listSenders operation.
|
Iterable<SuppressionSummary> |
listSuppressionsRecordIterator(ListSuppressionsRequest request)
Creates a new iterable which will iterate over the
SuppressionSummary objects contained in responses from the listSuppressions operation. |
Iterable<ListSuppressionsResponse> |
listSuppressionsResponseIterator(ListSuppressionsRequest request)
Creates a new iterable which will iterate over the responses received from the listSuppressions operation.
|
@ConstructorProperties(value="client") public EmailPaginators(Email client)
public Iterable<ListSendersResponse> listSendersResponseIterator(ListSendersRequest request)
Creates a new iterable which will iterate over the responses received from the listSenders operation. This iterable will fetch more data from the server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the responses received from the service.public Iterable<SenderSummary> listSendersRecordIterator(ListSendersRequest request)
Creates a new iterable which will iterate over the SenderSummary
objects contained in responses from the listSenders operation. This iterable will fetch more data from the server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the SenderSummary
objects contained in responses received from the service.public Iterable<ListSuppressionsResponse> listSuppressionsResponseIterator(ListSuppressionsRequest request)
Creates a new iterable which will iterate over the responses received from the listSuppressions operation. This iterable will fetch more data from the server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the responses received from the service.public Iterable<SuppressionSummary> listSuppressionsRecordIterator(ListSuppressionsRequest request)
Creates a new iterable which will iterate over the SuppressionSummary
objects contained in responses from the listSuppressions operation. This iterable will fetch more data from the server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the SuppressionSummary
objects contained in responses received from the service.Copyright © 2016–2019. All rights reserved.