Package com.oracle.bmc.batch

Class BatchComputingPaginators

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

      • BatchComputingPaginators

        public BatchComputingPaginators​(BatchComputing client)

    • Method Detail

      • listBatchContextShapesResponseIterator

        public Iterable<ListBatchContextShapesResponse> listBatchContextShapesResponseIterator​(ListBatchContextShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchContextShapes 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.

      • listBatchContextShapesRecordIterator

        public Iterable<BatchContextShapeSummary> listBatchContextShapesRecordIterator​(ListBatchContextShapesRequest request)
        Creates a new iterable which will iterate over the BatchContextShapeSummary objects contained in responses from the listBatchContextShapes 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 BatchContextShapeSummary objects contained in responses received from the service.

      • listBatchContextsResponseIterator

        public Iterable<ListBatchContextsResponse> listBatchContextsResponseIterator​(ListBatchContextsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchContexts 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.

      • listBatchContextsRecordIterator

        public Iterable<BatchContextSummary> listBatchContextsRecordIterator​(ListBatchContextsRequest request)
        Creates a new iterable which will iterate over the BatchContextSummary objects contained in responses from the listBatchContexts 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 BatchContextSummary objects contained in responses received from the service.

      • listBatchJobPoolsResponseIterator

        public Iterable<ListBatchJobPoolsResponse> listBatchJobPoolsResponseIterator​(ListBatchJobPoolsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchJobPools 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.

      • listBatchJobPoolsRecordIterator

        public Iterable<BatchJobPoolSummary> listBatchJobPoolsRecordIterator​(ListBatchJobPoolsRequest request)
        Creates a new iterable which will iterate over the BatchJobPoolSummary objects contained in responses from the listBatchJobPools 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 BatchJobPoolSummary objects contained in responses received from the service.

      • listBatchJobTasksResponseIterator

        public Iterable<ListBatchJobTasksResponse> listBatchJobTasksResponseIterator​(ListBatchJobTasksRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchJobTasks 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.

      • listBatchJobTasksRecordIterator

        public Iterable<BatchTaskSummary> listBatchJobTasksRecordIterator​(ListBatchJobTasksRequest request)
        Creates a new iterable which will iterate over the BatchTaskSummary objects contained in responses from the listBatchJobTasks 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 BatchTaskSummary objects contained in responses received from the service.

      • listBatchJobsResponseIterator

        public Iterable<ListBatchJobsResponse> listBatchJobsResponseIterator​(ListBatchJobsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchJobs 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.

      • listBatchJobsRecordIterator

        public Iterable<BatchJobSummary> listBatchJobsRecordIterator​(ListBatchJobsRequest request)
        Creates a new iterable which will iterate over the BatchJobSummary objects contained in responses from the listBatchJobs 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 BatchJobSummary objects contained in responses received from the service.

      • listBatchTaskEnvironmentsResponseIterator

        public Iterable<ListBatchTaskEnvironmentsResponse> listBatchTaskEnvironmentsResponseIterator​(ListBatchTaskEnvironmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchTaskEnvironments 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.

      • listBatchTaskProfilesResponseIterator

        public Iterable<ListBatchTaskProfilesResponse> listBatchTaskProfilesResponseIterator​(ListBatchTaskProfilesRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchTaskProfiles 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.

      • listBatchTaskProfilesRecordIterator

        public Iterable<BatchTaskProfileSummary> listBatchTaskProfilesRecordIterator​(ListBatchTaskProfilesRequest request)
        Creates a new iterable which will iterate over the BatchTaskProfileSummary objects contained in responses from the listBatchTaskProfiles 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 BatchTaskProfileSummary objects contained in responses received from the service.

      • listBatchTasksResponseIterator

        public Iterable<ListBatchTasksResponse> listBatchTasksResponseIterator​(ListBatchTasksRequest request)
        Creates a new iterable which will iterate over the responses received from the listBatchTasks 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.

      • listBatchTasksRecordIterator

        public Iterable<BatchTaskSummary> listBatchTasksRecordIterator​(ListBatchTasksRequest request)
        Creates a new iterable which will iterate over the BatchTaskSummary objects contained in responses from the listBatchTasks 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 BatchTaskSummary 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.