@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:
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 |
---|
GoldenGatePaginators(GoldenGate client) |
Modifier and Type | Method and Description |
---|---|
Iterable<CertificateSummary> |
listCertificatesRecordIterator(ListCertificatesRequest request)
Creates a new iterable which will iterate over the
CertificateSummary objects contained in responses from the
listCertificates operation. |
Iterable<ListCertificatesResponse> |
listCertificatesResponseIterator(ListCertificatesRequest request)
Creates a new iterable which will iterate over the responses received from the
listCertificates operation.
|
Iterable<ConnectionAssignmentSummary> |
listConnectionAssignmentsRecordIterator(ListConnectionAssignmentsRequest request)
Creates a new iterable which will iterate over the
ConnectionAssignmentSummary objects contained in responses
from the listConnectionAssignments operation. |
Iterable<ListConnectionAssignmentsResponse> |
listConnectionAssignmentsResponseIterator(ListConnectionAssignmentsRequest request)
Creates a new iterable which will iterate over the responses received from the
listConnectionAssignments operation.
|
Iterable<ConnectionSummary> |
listConnectionsRecordIterator(ListConnectionsRequest request)
Creates a new iterable which will iterate over the
ConnectionSummary objects contained in responses from the
listConnections operation. |
Iterable<ListConnectionsResponse> |
listConnectionsResponseIterator(ListConnectionsRequest request)
Creates a new iterable which will iterate over the responses received from the
listConnections operation.
|
Iterable<DatabaseRegistrationSummary> |
listDatabaseRegistrationsRecordIterator(ListDatabaseRegistrationsRequest request)
Creates a new iterable which will iterate over the
DatabaseRegistrationSummary objects contained in responses
from the listDatabaseRegistrations operation. |
Iterable<ListDatabaseRegistrationsResponse> |
listDatabaseRegistrationsResponseIterator(ListDatabaseRegistrationsRequest request)
Creates a new iterable which will iterate over the responses received from the
listDatabaseRegistrations operation.
|
Iterable<DeploymentBackupSummary> |
listDeploymentBackupsRecordIterator(ListDeploymentBackupsRequest request)
Creates a new iterable which will iterate over the
DeploymentBackupSummary objects contained in responses from
the listDeploymentBackups operation. |
Iterable<ListDeploymentBackupsResponse> |
listDeploymentBackupsResponseIterator(ListDeploymentBackupsRequest request)
Creates a new iterable which will iterate over the responses received from the
listDeploymentBackups operation.
|
Iterable<DeploymentEnvironmentSummary> |
listDeploymentEnvironmentsRecordIterator(ListDeploymentEnvironmentsRequest request)
Creates a new iterable which will iterate over the
DeploymentEnvironmentSummary objects contained in responses
from the listDeploymentEnvironments operation. |
Iterable<ListDeploymentEnvironmentsResponse> |
listDeploymentEnvironmentsResponseIterator(ListDeploymentEnvironmentsRequest request)
Creates a new iterable which will iterate over the responses received from the
listDeploymentEnvironments operation.
|
Iterable<DeploymentSummary> |
listDeploymentsRecordIterator(ListDeploymentsRequest request)
Creates a new iterable which will iterate over the
DeploymentSummary objects contained in responses from the
listDeployments operation. |
Iterable<ListDeploymentsResponse> |
listDeploymentsResponseIterator(ListDeploymentsRequest request)
Creates a new iterable which will iterate over the responses received from the
listDeployments operation.
|
Iterable<DeploymentTypeSummary> |
listDeploymentTypesRecordIterator(ListDeploymentTypesRequest request)
Creates a new iterable which will iterate over the
DeploymentTypeSummary objects contained in responses from
the listDeploymentTypes operation. |
Iterable<ListDeploymentTypesResponse> |
listDeploymentTypesResponseIterator(ListDeploymentTypesRequest request)
Creates a new iterable which will iterate over the responses received from the
listDeploymentTypes operation.
|
Iterable<DeploymentUpgradeSummary> |
listDeploymentUpgradesRecordIterator(ListDeploymentUpgradesRequest request)
Creates a new iterable which will iterate over the
DeploymentUpgradeSummary objects contained in responses from
the listDeploymentUpgrades operation. |
Iterable<ListDeploymentUpgradesResponse> |
listDeploymentUpgradesResponseIterator(ListDeploymentUpgradesRequest request)
Creates a new iterable which will iterate over the responses received from the
listDeploymentUpgrades operation.
|
Iterable<DeploymentVersionSummary> |
listDeploymentVersionsRecordIterator(ListDeploymentVersionsRequest request)
Creates a new iterable which will iterate over the
DeploymentVersionSummary objects contained in responses from
the listDeploymentVersions operation. |
Iterable<ListDeploymentVersionsResponse> |
listDeploymentVersionsResponseIterator(ListDeploymentVersionsRequest request)
Creates a new iterable which will iterate over the responses received from the
listDeploymentVersions operation.
|
Iterable<DeploymentWalletsOperationSummary> |
listDeploymentWalletsOperationsRecordIterator(ListDeploymentWalletsOperationsRequest request)
Creates a new iterable which will iterate over the
DeploymentWalletsOperationSummary objects contained in
responses from the listDeploymentWalletsOperations operation. |
Iterable<ListDeploymentWalletsOperationsResponse> |
listDeploymentWalletsOperationsResponseIterator(ListDeploymentWalletsOperationsRequest request)
Creates a new iterable which will iterate over the responses received from the
listDeploymentWalletsOperations operation.
|
Iterable<TrailFileSummary> |
listTrailFilesRecordIterator(ListTrailFilesRequest request)
Creates a new iterable which will iterate over the
TrailFileSummary objects contained in responses from the
listTrailFiles operation. |
Iterable<ListTrailFilesResponse> |
listTrailFilesResponseIterator(ListTrailFilesRequest request)
Creates a new iterable which will iterate over the responses received from the listTrailFiles
operation.
|
Iterable<TrailSequenceSummary> |
listTrailSequencesRecordIterator(ListTrailSequencesRequest request)
Creates a new iterable which will iterate over the
TrailSequenceSummary objects contained in responses from the
listTrailSequences operation. |
Iterable<ListTrailSequencesResponse> |
listTrailSequencesResponseIterator(ListTrailSequencesRequest request)
Creates a new iterable which will iterate over the responses received from the
listTrailSequences operation.
|
Iterable<WorkRequestError> |
listWorkRequestErrorsRecordIterator(ListWorkRequestErrorsRequest request)
Creates a new iterable which will iterate over the
WorkRequestError objects contained in responses from the
listWorkRequestErrors operation. |
Iterable<ListWorkRequestErrorsResponse> |
listWorkRequestErrorsResponseIterator(ListWorkRequestErrorsRequest request)
Creates a new iterable which will iterate over the responses received from the
listWorkRequestErrors operation.
|
Iterable<WorkRequestLogEntry> |
listWorkRequestLogsRecordIterator(ListWorkRequestLogsRequest request)
Creates a new iterable which will iterate over the
WorkRequestLogEntry objects contained in responses from the
listWorkRequestLogs operation. |
Iterable<ListWorkRequestLogsResponse> |
listWorkRequestLogsResponseIterator(ListWorkRequestLogsRequest request)
Creates a new iterable which will iterate over the responses received from the
listWorkRequestLogs operation.
|
Iterable<WorkRequest> |
listWorkRequestsRecordIterator(ListWorkRequestsRequest request)
Creates a new iterable which will iterate over the
WorkRequest objects contained in responses from the
listWorkRequests operation. |
Iterable<ListWorkRequestsResponse> |
listWorkRequestsResponseIterator(ListWorkRequestsRequest request)
Creates a new iterable which will iterate over the responses received from the
listWorkRequests operation.
|
public GoldenGatePaginators(GoldenGate client)
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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the CertificateSummary
objects contained in responses
received from the service.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.
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<ConnectionAssignmentSummary> listConnectionAssignmentsRecordIterator(ListConnectionAssignmentsRequest request)
Creates a new iterable which will iterate over the ConnectionAssignmentSummary
objects contained in responses
from the listConnectionAssignments 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 ConnectionAssignmentSummary
objects contained in
responses received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the ConnectionSummary
objects contained in responses
received from the service.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.
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<DatabaseRegistrationSummary> listDatabaseRegistrationsRecordIterator(ListDatabaseRegistrationsRequest request)
Creates a new iterable which will iterate over the DatabaseRegistrationSummary
objects contained in responses
from the listDatabaseRegistrations 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 DatabaseRegistrationSummary
objects contained in
responses received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the DeploymentBackupSummary
objects contained in responses
received from the service.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.
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<DeploymentEnvironmentSummary> listDeploymentEnvironmentsRecordIterator(ListDeploymentEnvironmentsRequest request)
Creates a new iterable which will iterate over the DeploymentEnvironmentSummary
objects contained in responses
from the listDeploymentEnvironments 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 DeploymentEnvironmentSummary
objects contained in
responses received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the DeploymentTypeSummary
objects contained in responses
received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the DeploymentUpgradeSummary
objects contained in responses
received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the DeploymentVersionSummary
objects contained in responses
received from the service.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.
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<DeploymentWalletsOperationSummary> listDeploymentWalletsOperationsRecordIterator(ListDeploymentWalletsOperationsRequest request)
Creates a new iterable which will iterate over the DeploymentWalletsOperationSummary
objects contained in
responses from the listDeploymentWalletsOperations 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 DeploymentWalletsOperationSummary
objects contained in
responses received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the DeploymentSummary
objects contained in responses
received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the TrailFileSummary
objects contained in responses received
from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the TrailSequenceSummary
objects contained in responses
received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the WorkRequestError
objects contained in responses received
from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the WorkRequestLogEntry
objects contained in responses
received from the service.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.
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<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.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the WorkRequest
objects contained in responses received from
the service.Copyright © 2016–2024. All rights reserved.