Class MigrationPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of Migration 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
MigrationPaginators
Inherited Members
Namespace: Oci.CloudmigrationsService
Assembly: OCI.DotNetSDK.Cloudmigrations.dll
Syntax
public class MigrationPaginators

Constructors

MigrationPaginators(MigrationClient)

Declaration
public MigrationPaginators(MigrationClient client)
Parameters
Type Name Description
MigrationClient client

Methods

ListAvailableShapesRecordEnumerator(ListAvailableShapesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<AvailableShapeSummary> ListAvailableShapesRecordEnumerator(ListAvailableShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListAvailableShapesRequest 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<AvailableShapeSummary>

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

ListAvailableShapesResponseEnumerator(ListAvailableShapesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListAvailableShapesResponse> ListAvailableShapesResponseEnumerator(ListAvailableShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListAvailableShapesRequest 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<ListAvailableShapesResponse>

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

ListMigrationAssetsRecordEnumerator(ListMigrationAssetsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<MigrationAssetSummary> ListMigrationAssetsRecordEnumerator(ListMigrationAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationAssetsRequest 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<MigrationAssetSummary>

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

ListMigrationAssetsResponseEnumerator(ListMigrationAssetsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListMigrationAssetsResponse> ListMigrationAssetsResponseEnumerator(ListMigrationAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationAssetsRequest 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<ListMigrationAssetsResponse>

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

ListMigrationPlansRecordEnumerator(ListMigrationPlansRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<MigrationPlanSummary> ListMigrationPlansRecordEnumerator(ListMigrationPlansRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationPlansRequest 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<MigrationPlanSummary>

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

ListMigrationPlansResponseEnumerator(ListMigrationPlansRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListMigrationPlansResponse> ListMigrationPlansResponseEnumerator(ListMigrationPlansRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListMigrationPlansRequest 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<ListMigrationPlansResponse>

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

ListReplicationSchedulesRecordEnumerator(ListReplicationSchedulesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ReplicationScheduleSummary> ListReplicationSchedulesRecordEnumerator(ListReplicationSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListReplicationSchedulesRequest 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<ReplicationScheduleSummary>

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

ListReplicationSchedulesResponseEnumerator(ListReplicationSchedulesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListReplicationSchedulesResponse> ListReplicationSchedulesResponseEnumerator(ListReplicationSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListReplicationSchedulesRequest 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<ListReplicationSchedulesResponse>

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

ListTargetAssetsRecordEnumerator(ListTargetAssetsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<TargetAssetSummary> ListTargetAssetsRecordEnumerator(ListTargetAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListTargetAssetsRequest 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<TargetAssetSummary>

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

ListTargetAssetsResponseEnumerator(ListTargetAssetsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListTargetAssetsResponse> ListTargetAssetsResponseEnumerator(ListTargetAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListTargetAssetsRequest 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<ListTargetAssetsResponse>

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