Package com.oracle.bmc.email

Class EmailPaginators

  • @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:

    • Iterating over the Response objects returned by the list operation. These are referred to as ResponseIterators, and the methods are suffixed with ResponseIterator. For example: listUsersResponseIterator
    • Iterating over the resources/records being listed. These are referred to as RecordIterators, and the methods are suffixed with RecordIterator. For example: listUsersRecordIterator

    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 Detail

      • EmailPaginators

        public EmailPaginators​(Email client)

    • Method Detail

      • listDkimsResponseIterator

        public Iterable<ListDkimsResponse> listDkimsResponseIterator​(ListDkimsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDkims operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listDkimsRecordIterator

        public Iterable<DkimSummary> listDkimsRecordIterator​(ListDkimsRequest request)
        Creates a new iterable which will iterate over the DkimSummary objects contained in responses from the listDkims operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the DkimSummary objects contained in responses received from the service.

      • listEmailDomainsResponseIterator

        public Iterable<ListEmailDomainsResponse> listEmailDomainsResponseIterator​(ListEmailDomainsRequest request)
        Creates a new iterable which will iterate over the responses received from the listEmailDomains operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listEmailDomainsRecordIterator

        public Iterable<EmailDomainSummary> listEmailDomainsRecordIterator​(ListEmailDomainsRequest request)
        Creates a new iterable which will iterate over the EmailDomainSummary objects contained in responses from the listEmailDomains operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the EmailDomainSummary objects contained in responses received from the service.

      • listEmailReturnPathsResponseIterator

        public Iterable<ListEmailReturnPathsResponse> listEmailReturnPathsResponseIterator​(ListEmailReturnPathsRequest request)
        Creates a new iterable which will iterate over the responses received from the listEmailReturnPaths operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listEmailReturnPathsRecordIterator

        public Iterable<EmailReturnPathSummary> listEmailReturnPathsRecordIterator​(ListEmailReturnPathsRequest request)
        Creates a new iterable which will iterate over the EmailReturnPathSummary objects contained in responses from the listEmailReturnPaths operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the EmailReturnPathSummary objects contained in responses received from the service.

      • listSendersResponseIterator

        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.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listSendersRecordIterator

        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.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the SenderSummary objects contained in responses received from the service.

      • listSuppressionsResponseIterator

        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.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listSuppressionsRecordIterator

        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.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the SuppressionSummary objects contained in responses received from the service.

      • listWorkRequestErrorsResponseIterator

        public Iterable<ListWorkRequestErrorsResponse> listWorkRequestErrorsResponseIterator​(ListWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequestErrors operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listWorkRequestErrorsRecordIterator

        public Iterable<WorkRequestError> listWorkRequestErrorsRecordIterator​(ListWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the WorkRequestError objects contained in responses from the listWorkRequestErrors operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the WorkRequestError objects contained in responses received from the service.

      • listWorkRequestLogsResponseIterator

        public Iterable<ListWorkRequestLogsResponse> listWorkRequestLogsResponseIterator​(ListWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequestLogs operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listWorkRequestLogsRecordIterator

        public Iterable<WorkRequestLogEntry> listWorkRequestLogsRecordIterator​(ListWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the WorkRequestLogEntry objects contained in responses received from the service.

      • listWorkRequestsResponseIterator

        public Iterable<ListWorkRequestsResponse> listWorkRequestsResponseIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequests operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the responses received from the service.

      • listWorkRequestsRecordIterator

        public Iterable<WorkRequestSummary> listWorkRequestsRecordIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the WorkRequestSummary objects contained in responses from the listWorkRequests operation.

        This iterable will fetch more data from the server as needed.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the WorkRequestSummary objects contained in responses received from the service.