Package com.oracle.bmc.goldengate

Class GoldenGatePaginators

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

      • GoldenGatePaginators

        public GoldenGatePaginators​(GoldenGate client)

    • Method Detail

      • listCertificatesResponseIterator

        public Iterable<ListCertificatesResponse> listCertificatesResponseIterator​(ListCertificatesRequest request)
        Creates a new iterable which will iterate over the responses received from the listCertificates 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.

      • listCertificatesRecordIterator

        public Iterable<CertificateSummary> listCertificatesRecordIterator​(ListCertificatesRequest request)
        Creates a new iterable which will iterate over the CertificateSummary objects contained in responses from the listCertificates 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 CertificateSummary objects contained in responses received from the service.

      • listConnectionAssignmentsResponseIterator

        public Iterable<ListConnectionAssignmentsResponse> listConnectionAssignmentsResponseIterator​(ListConnectionAssignmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listConnectionAssignments 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.

      • listConnectionsResponseIterator

        public Iterable<ListConnectionsResponse> listConnectionsResponseIterator​(ListConnectionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listConnections 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.

      • listConnectionsRecordIterator

        public Iterable<ConnectionSummary> listConnectionsRecordIterator​(ListConnectionsRequest request)
        Creates a new iterable which will iterate over the ConnectionSummary objects contained in responses from the listConnections 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 ConnectionSummary objects contained in responses received from the service.

      • listDatabaseRegistrationsResponseIterator

        public Iterable<ListDatabaseRegistrationsResponse> listDatabaseRegistrationsResponseIterator​(ListDatabaseRegistrationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDatabaseRegistrations 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.

      • listDeploymentBackupsResponseIterator

        public Iterable<ListDeploymentBackupsResponse> listDeploymentBackupsResponseIterator​(ListDeploymentBackupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeploymentBackups 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.

      • listDeploymentBackupsRecordIterator

        public Iterable<DeploymentBackupSummary> listDeploymentBackupsRecordIterator​(ListDeploymentBackupsRequest request)
        Creates a new iterable which will iterate over the DeploymentBackupSummary objects contained in responses from the listDeploymentBackups 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 DeploymentBackupSummary objects contained in responses received from the service.

      • listDeploymentEnvironmentsResponseIterator

        public Iterable<ListDeploymentEnvironmentsResponse> listDeploymentEnvironmentsResponseIterator​(ListDeploymentEnvironmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeploymentEnvironments 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.

      • listDeploymentPeersResponseIterator

        public Iterable<ListDeploymentPeersResponse> listDeploymentPeersResponseIterator​(ListDeploymentPeersRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeploymentPeers 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.

      • listDeploymentPeersRecordIterator

        public Iterable<DeploymentPeerSummary> listDeploymentPeersRecordIterator​(ListDeploymentPeersRequest request)
        Creates a new iterable which will iterate over the DeploymentPeerSummary objects contained in responses from the listDeploymentPeers 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 DeploymentPeerSummary objects contained in responses received from the service.

      • listDeploymentTypesResponseIterator

        public Iterable<ListDeploymentTypesResponse> listDeploymentTypesResponseIterator​(ListDeploymentTypesRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeploymentTypes 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.

      • listDeploymentTypesRecordIterator

        public Iterable<DeploymentTypeSummary> listDeploymentTypesRecordIterator​(ListDeploymentTypesRequest request)
        Creates a new iterable which will iterate over the DeploymentTypeSummary objects contained in responses from the listDeploymentTypes 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 DeploymentTypeSummary objects contained in responses received from the service.

      • listDeploymentUpgradesResponseIterator

        public Iterable<ListDeploymentUpgradesResponse> listDeploymentUpgradesResponseIterator​(ListDeploymentUpgradesRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeploymentUpgrades 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.

      • listDeploymentUpgradesRecordIterator

        public Iterable<DeploymentUpgradeSummary> listDeploymentUpgradesRecordIterator​(ListDeploymentUpgradesRequest request)
        Creates a new iterable which will iterate over the DeploymentUpgradeSummary objects contained in responses from the listDeploymentUpgrades 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 DeploymentUpgradeSummary objects contained in responses received from the service.

      • listDeploymentVersionsResponseIterator

        public Iterable<ListDeploymentVersionsResponse> listDeploymentVersionsResponseIterator​(ListDeploymentVersionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeploymentVersions 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.

      • listDeploymentVersionsRecordIterator

        public Iterable<DeploymentVersionSummary> listDeploymentVersionsRecordIterator​(ListDeploymentVersionsRequest request)
        Creates a new iterable which will iterate over the DeploymentVersionSummary objects contained in responses from the listDeploymentVersions 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 DeploymentVersionSummary objects contained in responses received from the service.

      • listDeploymentWalletsOperationsResponseIterator

        public Iterable<ListDeploymentWalletsOperationsResponse> listDeploymentWalletsOperationsResponseIterator​(ListDeploymentWalletsOperationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeploymentWalletsOperations 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.

      • listDeploymentsResponseIterator

        public Iterable<ListDeploymentsResponse> listDeploymentsResponseIterator​(ListDeploymentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDeployments 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.

      • listDeploymentsRecordIterator

        public Iterable<DeploymentSummary> listDeploymentsRecordIterator​(ListDeploymentsRequest request)
        Creates a new iterable which will iterate over the DeploymentSummary objects contained in responses from the listDeployments 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 DeploymentSummary objects contained in responses received from the service.

      • listPipelineRunningProcessesResponseIterator

        public Iterable<ListPipelineRunningProcessesResponse> listPipelineRunningProcessesResponseIterator​(ListPipelineRunningProcessesRequest request)
        Creates a new iterable which will iterate over the responses received from the listPipelineRunningProcesses 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.

      • listPipelineSchemaTablesResponseIterator

        public Iterable<ListPipelineSchemaTablesResponse> listPipelineSchemaTablesResponseIterator​(ListPipelineSchemaTablesRequest request)
        Creates a new iterable which will iterate over the responses received from the listPipelineSchemaTables 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.

      • listPipelineSchemasResponseIterator

        public Iterable<ListPipelineSchemasResponse> listPipelineSchemasResponseIterator​(ListPipelineSchemasRequest request)
        Creates a new iterable which will iterate over the responses received from the listPipelineSchemas 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.

      • listPipelineSchemasRecordIterator

        public Iterable<PipelineSchemaSummary> listPipelineSchemasRecordIterator​(ListPipelineSchemasRequest request)
        Creates a new iterable which will iterate over the PipelineSchemaSummary objects contained in responses from the listPipelineSchemas 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 PipelineSchemaSummary objects contained in responses received from the service.

      • listPipelinesResponseIterator

        public Iterable<ListPipelinesResponse> listPipelinesResponseIterator​(ListPipelinesRequest request)
        Creates a new iterable which will iterate over the responses received from the listPipelines 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.

      • listPipelinesRecordIterator

        public Iterable<PipelineSummary> listPipelinesRecordIterator​(ListPipelinesRequest request)
        Creates a new iterable which will iterate over the PipelineSummary objects contained in responses from the listPipelines 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 PipelineSummary objects contained in responses received from the service.

      • listRecipesResponseIterator

        public Iterable<ListRecipesResponse> listRecipesResponseIterator​(ListRecipesRequest request)
        Creates a new iterable which will iterate over the responses received from the listRecipes 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.

      • listRecipesRecordIterator

        public Iterable<RecipeSummary> listRecipesRecordIterator​(ListRecipesRequest request)
        Creates a new iterable which will iterate over the RecipeSummary objects contained in responses from the listRecipes 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 RecipeSummary objects contained in responses received from the service.

      • listTrailFilesResponseIterator

        public Iterable<ListTrailFilesResponse> listTrailFilesResponseIterator​(ListTrailFilesRequest request)
        Creates a new iterable which will iterate over the responses received from the listTrailFiles 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.

      • listTrailFilesRecordIterator

        public Iterable<TrailFileSummary> listTrailFilesRecordIterator​(ListTrailFilesRequest request)
        Creates a new iterable which will iterate over the TrailFileSummary objects contained in responses from the listTrailFiles 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 TrailFileSummary objects contained in responses received from the service.

      • listTrailSequencesResponseIterator

        public Iterable<ListTrailSequencesResponse> listTrailSequencesResponseIterator​(ListTrailSequencesRequest request)
        Creates a new iterable which will iterate over the responses received from the listTrailSequences 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.

      • listTrailSequencesRecordIterator

        public Iterable<TrailSequenceSummary> listTrailSequencesRecordIterator​(ListTrailSequencesRequest request)
        Creates a new iterable which will iterate over the TrailSequenceSummary objects contained in responses from the listTrailSequences 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 TrailSequenceSummary 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<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.