Package com.oracle.bmc.bds

Class BdsPaginators

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

      • BdsPaginators

        public BdsPaginators​(Bds client)

    • Method Detail

      • listAutoScalingConfigurationsResponseIterator

        public Iterable<ListAutoScalingConfigurationsResponse> listAutoScalingConfigurationsResponseIterator​(ListAutoScalingConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAutoScalingConfigurations 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.

      • listBdsApiKeysResponseIterator

        public Iterable<ListBdsApiKeysResponse> listBdsApiKeysResponseIterator​(ListBdsApiKeysRequest request)
        Creates a new iterable which will iterate over the responses received from the listBdsApiKeys 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.

      • listBdsApiKeysRecordIterator

        public Iterable<BdsApiKeySummary> listBdsApiKeysRecordIterator​(ListBdsApiKeysRequest request)
        Creates a new iterable which will iterate over the BdsApiKeySummary objects contained in responses from the listBdsApiKeys 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 BdsApiKeySummary objects contained in responses received from the service.

      • listBdsClusterVersionsResponseIterator

        public Iterable<ListBdsClusterVersionsResponse> listBdsClusterVersionsResponseIterator​(ListBdsClusterVersionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBdsClusterVersions 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.

      • listBdsClusterVersionsRecordIterator

        public Iterable<BdsClusterVersionSummary> listBdsClusterVersionsRecordIterator​(ListBdsClusterVersionsRequest request)
        Creates a new iterable which will iterate over the BdsClusterVersionSummary objects contained in responses from the listBdsClusterVersions 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 BdsClusterVersionSummary objects contained in responses received from the service.

      • listBdsInstancesResponseIterator

        public Iterable<ListBdsInstancesResponse> listBdsInstancesResponseIterator​(ListBdsInstancesRequest request)
        Creates a new iterable which will iterate over the responses received from the listBdsInstances 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.

      • listBdsInstancesRecordIterator

        public Iterable<BdsInstanceSummary> listBdsInstancesRecordIterator​(ListBdsInstancesRequest request)
        Creates a new iterable which will iterate over the BdsInstanceSummary objects contained in responses from the listBdsInstances 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 BdsInstanceSummary objects contained in responses received from the service.

      • listBdsMetastoreConfigurationsResponseIterator

        public Iterable<ListBdsMetastoreConfigurationsResponse> listBdsMetastoreConfigurationsResponseIterator​(ListBdsMetastoreConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBdsMetastoreConfigurations 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.

      • listIdentityConfigurationsResponseIterator

        public Iterable<ListIdentityConfigurationsResponse> listIdentityConfigurationsResponseIterator​(ListIdentityConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listIdentityConfigurations 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.

      • listNodeBackupConfigurationsResponseIterator

        public Iterable<ListNodeBackupConfigurationsResponse> listNodeBackupConfigurationsResponseIterator​(ListNodeBackupConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listNodeBackupConfigurations 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.

      • listNodeBackupsResponseIterator

        public Iterable<ListNodeBackupsResponse> listNodeBackupsResponseIterator​(ListNodeBackupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listNodeBackups 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.

      • listNodeBackupsRecordIterator

        public Iterable<NodeBackupSummary> listNodeBackupsRecordIterator​(ListNodeBackupsRequest request)
        Creates a new iterable which will iterate over the NodeBackupSummary objects contained in responses from the listNodeBackups 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 NodeBackupSummary objects contained in responses received from the service.

      • listNodeReplaceConfigurationsResponseIterator

        public Iterable<ListNodeReplaceConfigurationsResponse> listNodeReplaceConfigurationsResponseIterator​(ListNodeReplaceConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listNodeReplaceConfigurations 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.

      • listOsPatchesResponseIterator

        public Iterable<ListOsPatchesResponse> listOsPatchesResponseIterator​(ListOsPatchesRequest request)
        Creates a new iterable which will iterate over the responses received from the listOsPatches 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.

      • listOsPatchesRecordIterator

        public Iterable<OsPatchSummary> listOsPatchesRecordIterator​(ListOsPatchesRequest request)
        Creates a new iterable which will iterate over the OsPatchSummary objects contained in responses from the listOsPatches 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 OsPatchSummary objects contained in responses received from the service.

      • listPatchHistoriesResponseIterator

        public Iterable<ListPatchHistoriesResponse> listPatchHistoriesResponseIterator​(ListPatchHistoriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listPatchHistories 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.

      • listPatchHistoriesRecordIterator

        public Iterable<PatchHistorySummary> listPatchHistoriesRecordIterator​(ListPatchHistoriesRequest request)
        Creates a new iterable which will iterate over the PatchHistorySummary objects contained in responses from the listPatchHistories 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 PatchHistorySummary objects contained in responses received from the service.

      • listPatchesResponseIterator

        public Iterable<ListPatchesResponse> listPatchesResponseIterator​(ListPatchesRequest request)
        Creates a new iterable which will iterate over the responses received from the listPatches 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.

      • listPatchesRecordIterator

        public Iterable<PatchSummary> listPatchesRecordIterator​(ListPatchesRequest request)
        Creates a new iterable which will iterate over the PatchSummary objects contained in responses from the listPatches 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 PatchSummary objects contained in responses received from the service.

      • listResourcePrincipalConfigurationsResponseIterator

        public Iterable<ListResourcePrincipalConfigurationsResponse> listResourcePrincipalConfigurationsResponseIterator​(ListResourcePrincipalConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listResourcePrincipalConfigurations 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.

      • 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<WorkRequest> listWorkRequestsRecordIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the WorkRequest 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 WorkRequest objects contained in responses received from the service.