Class DatabaseMigrationPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of DatabaseMigration where multiple pages of data may be fetched. Two styles of enumerators are supported:

  • Enumerating over the Response objects returned by the list operation. These are referred to as ResponseEnumerators, and the methods are suffixed with ResponseEnumerator. For example: listUsersResponseEnumerator.
  • Enumerating over the resources/records being listed. These are referred to as RecordEnumerators, and the methods are suffixed with RecordEnumerator. For example: listUsersRecordEnumerator.
These enumerators 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 iterator returned by calling a ResponseEnumerator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the enumerables returned by calling a RecordEnumerator 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.
Inheritance
object
DatabaseMigrationPaginators
Inherited Members
Namespace: Oci.DatabasemigrationService
Assembly: OCI.DotNetSDK.Databasemigration.dll
Syntax
public class DatabaseMigrationPaginators

Constructors

DatabaseMigrationPaginators(DatabaseMigrationClient)

Declaration
public DatabaseMigrationPaginators(DatabaseMigrationClient client)
Parameters
Type Name Description
DatabaseMigrationClient client

Methods

ListConnectionsRecordEnumerator(ListConnectionsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the ConnectionSummary objects contained in responses from the ListConnections operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ConnectionSummary> ListConnectionsRecordEnumerator(ListConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListConnectionsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ConnectionSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListConnectionsResponseEnumerator(ListConnectionsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListConnections operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListConnectionsResponse> ListConnectionsResponseEnumerator(ListConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListConnectionsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListConnectionsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListExcludedObjectsRecordEnumerator(ListExcludedObjectsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the ExcludedObjectSummary objects contained in responses from the ListExcludedObjects operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ExcludedObjectSummary> ListExcludedObjectsRecordEnumerator(ListExcludedObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListExcludedObjectsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ExcludedObjectSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListExcludedObjectsResponseEnumerator(ListExcludedObjectsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListExcludedObjects operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListExcludedObjectsResponse> ListExcludedObjectsResponseEnumerator(ListExcludedObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListExcludedObjectsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListExcludedObjectsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListJobOutputsRecordEnumerator(ListJobOutputsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the JobOutputSummary objects contained in responses from the ListJobOutputs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<JobOutputSummary> ListJobOutputsRecordEnumerator(ListJobOutputsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListJobOutputsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<JobOutputSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListJobOutputsResponseEnumerator(ListJobOutputsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListJobOutputs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListJobOutputsResponse> ListJobOutputsResponseEnumerator(ListJobOutputsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListJobOutputsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListJobOutputsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListJobsRecordEnumerator(ListJobsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the JobSummary objects contained in responses from the ListJobs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<JobSummary> ListJobsRecordEnumerator(ListJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListJobsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<JobSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListJobsResponseEnumerator(ListJobsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListJobs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListJobsResponse> ListJobsResponseEnumerator(ListJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListJobsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListJobsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListMigrationObjectTypesRecordEnumerator(ListMigrationObjectTypesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the MigrationObjectTypeSummary objects contained in responses from the ListMigrationObjectTypes operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<MigrationObjectTypeSummary> ListMigrationObjectTypesRecordEnumerator(ListMigrationObjectTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationObjectTypesRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<MigrationObjectTypeSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListMigrationObjectTypesResponseEnumerator(ListMigrationObjectTypesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListMigrationObjectTypes operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListMigrationObjectTypesResponse> ListMigrationObjectTypesResponseEnumerator(ListMigrationObjectTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationObjectTypesRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListMigrationObjectTypesResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListMigrationParametersRecordEnumerator(ListMigrationParametersRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the MigrationParameterSummary objects contained in responses from the ListMigrationParameters operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<MigrationParameterSummary> ListMigrationParametersRecordEnumerator(ListMigrationParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationParametersRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<MigrationParameterSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListMigrationParametersResponseEnumerator(ListMigrationParametersRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListMigrationParameters operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListMigrationParametersResponse> ListMigrationParametersResponseEnumerator(ListMigrationParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationParametersRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListMigrationParametersResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListMigrationsRecordEnumerator(ListMigrationsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the MigrationSummary objects contained in responses from the ListMigrations operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<MigrationSummary> ListMigrationsRecordEnumerator(ListMigrationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<MigrationSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListMigrationsResponseEnumerator(ListMigrationsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListMigrations operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListMigrationsResponse> ListMigrationsResponseEnumerator(ListMigrationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListMigrationsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListParameterFileVersionsRecordEnumerator(ListParameterFileVersionsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the ParameterFileVersionSummary objects contained in responses from the ListParameterFileVersions operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ParameterFileVersionSummary> ListParameterFileVersionsRecordEnumerator(ListParameterFileVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListParameterFileVersionsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ParameterFileVersionSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListParameterFileVersionsResponseEnumerator(ListParameterFileVersionsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListParameterFileVersions operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListParameterFileVersionsResponse> ListParameterFileVersionsResponseEnumerator(ListParameterFileVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListParameterFileVersionsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListParameterFileVersionsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestError objects contained in responses from the ListWorkRequestErrors operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestError> ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestError>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequestErrors operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestErrorsResponse> ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestErrorsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestLogEntry objects contained in responses from the ListWorkRequestLogs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestLogEntry> ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestLogEntry>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequestLogs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestLogsResponse> ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestLogsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestSummary objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestSummary> ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestsResponse> ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type