Package com.oracle.bmc.cloudmigrations

Class MigrationPaginators

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

      • MigrationPaginators

        public MigrationPaginators​(Migration client)

    • Method Detail

      • listAvailableShapesResponseIterator

        public Iterable<ListAvailableShapesResponse> listAvailableShapesResponseIterator​(ListAvailableShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listAvailableShapes 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.

      • listAvailableShapesRecordIterator

        public Iterable<AvailableShapeSummary> listAvailableShapesRecordIterator​(ListAvailableShapesRequest request)
        Creates a new iterable which will iterate over the AvailableShapeSummary objects contained in responses from the listAvailableShapes 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 AvailableShapeSummary objects contained in responses received from the service.

      • listMigrationAssetsResponseIterator

        public Iterable<ListMigrationAssetsResponse> listMigrationAssetsResponseIterator​(ListMigrationAssetsRequest request)
        Creates a new iterable which will iterate over the responses received from the listMigrationAssets 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.

      • listMigrationAssetsRecordIterator

        public Iterable<MigrationAssetSummary> listMigrationAssetsRecordIterator​(ListMigrationAssetsRequest request)
        Creates a new iterable which will iterate over the MigrationAssetSummary objects contained in responses from the listMigrationAssets 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 MigrationAssetSummary objects contained in responses received from the service.

      • listMigrationPlansResponseIterator

        public Iterable<ListMigrationPlansResponse> listMigrationPlansResponseIterator​(ListMigrationPlansRequest request)
        Creates a new iterable which will iterate over the responses received from the listMigrationPlans 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.

      • listMigrationPlansRecordIterator

        public Iterable<MigrationPlanSummary> listMigrationPlansRecordIterator​(ListMigrationPlansRequest request)
        Creates a new iterable which will iterate over the MigrationPlanSummary objects contained in responses from the listMigrationPlans 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 MigrationPlanSummary objects contained in responses received from the service.

      • listMigrationsResponseIterator

        public Iterable<ListMigrationsResponse> listMigrationsResponseIterator​(ListMigrationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listMigrations 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.

      • listMigrationsRecordIterator

        public Iterable<MigrationSummary> listMigrationsRecordIterator​(ListMigrationsRequest request)
        Creates a new iterable which will iterate over the MigrationSummary objects contained in responses from the listMigrations 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 MigrationSummary objects contained in responses received from the service.

      • listReplicationSchedulesResponseIterator

        public Iterable<ListReplicationSchedulesResponse> listReplicationSchedulesResponseIterator​(ListReplicationSchedulesRequest request)
        Creates a new iterable which will iterate over the responses received from the listReplicationSchedules 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.

      • listTargetAssetsResponseIterator

        public Iterable<ListTargetAssetsResponse> listTargetAssetsResponseIterator​(ListTargetAssetsRequest request)
        Creates a new iterable which will iterate over the responses received from the listTargetAssets 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.

      • listTargetAssetsRecordIterator

        public Iterable<TargetAssetSummary> listTargetAssetsRecordIterator​(ListTargetAssetsRequest request)
        Creates a new iterable which will iterate over the TargetAssetSummary objects contained in responses from the listTargetAssets 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 TargetAssetSummary 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<WorkRequestSummary> listWorkRequestsRecordIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the WorkRequestSummary 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 WorkRequestSummary objects contained in responses received from the service.