Package com.oracle.bmc.psql

Class PostgresqlPaginators

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220915")
public class PostgresqlPaginators
extends Object
    Collection of helper methods that can be used to provide an Iterable interface to any list operations of Postgresql 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

      • PostgresqlPaginators

        public PostgresqlPaginators​(Postgresql client)

    • Method Detail

      • listBackupsResponseIterator

        public Iterable<ListBackupsResponse> listBackupsResponseIterator​(ListBackupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBackups 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.

      • listBackupsRecordIterator

        public Iterable<BackupSummary> listBackupsRecordIterator​(ListBackupsRequest request)
        Creates a new iterable which will iterate over the BackupSummary objects contained in responses from the listBackups 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 BackupSummary objects contained in responses received from the service.

      • listConfigurationsResponseIterator

        public Iterable<ListConfigurationsResponse> listConfigurationsResponseIterator​(ListConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listConfigurations 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.

      • listConfigurationsRecordIterator

        public Iterable<ConfigurationSummary> listConfigurationsRecordIterator​(ListConfigurationsRequest request)
        Creates a new iterable which will iterate over the ConfigurationSummary objects contained in responses from the listConfigurations 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 ConfigurationSummary objects contained in responses received from the service.

      • listDbSystemsResponseIterator

        public Iterable<ListDbSystemsResponse> listDbSystemsResponseIterator​(ListDbSystemsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDbSystems 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.

      • listDbSystemsRecordIterator

        public Iterable<DbSystemSummary> listDbSystemsRecordIterator​(ListDbSystemsRequest request)
        Creates a new iterable which will iterate over the DbSystemSummary objects contained in responses from the listDbSystems 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 DbSystemSummary objects contained in responses received from the service.

      • listDefaultConfigurationsResponseIterator

        public Iterable<ListDefaultConfigurationsResponse> listDefaultConfigurationsResponseIterator​(ListDefaultConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDefaultConfigurations 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.

      • listShapesResponseIterator

        public Iterable<ListShapesResponse> listShapesResponseIterator​(ListShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listShapes 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.

      • listShapesRecordIterator

        public Iterable<ShapeSummary> listShapesRecordIterator​(ListShapesRequest request)
        Creates a new iterable which will iterate over the ShapeSummary objects contained in responses from the listShapes 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 ShapeSummary 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.