Package com.oracle.bmc.optimizer

Class OptimizerPaginators

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

      • OptimizerPaginators

        public OptimizerPaginators​(Optimizer client)

    • Method Detail

      • listCategoriesResponseIterator

        public Iterable<ListCategoriesResponse> listCategoriesResponseIterator​(ListCategoriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listCategories 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.

      • listCategoriesRecordIterator

        public Iterable<CategorySummary> listCategoriesRecordIterator​(ListCategoriesRequest request)
        Creates a new iterable which will iterate over the CategorySummary objects contained in responses from the listCategories 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 CategorySummary objects contained in responses received from the service.

      • listEnrollmentStatusesResponseIterator

        public Iterable<ListEnrollmentStatusesResponse> listEnrollmentStatusesResponseIterator​(ListEnrollmentStatusesRequest request)
        Creates a new iterable which will iterate over the responses received from the listEnrollmentStatuses 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.

      • listEnrollmentStatusesRecordIterator

        public Iterable<EnrollmentStatusSummary> listEnrollmentStatusesRecordIterator​(ListEnrollmentStatusesRequest request)
        Creates a new iterable which will iterate over the EnrollmentStatusSummary objects contained in responses from the listEnrollmentStatuses 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 EnrollmentStatusSummary objects contained in responses received from the service.

      • listHistoriesResponseIterator

        public Iterable<ListHistoriesResponse> listHistoriesResponseIterator​(ListHistoriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listHistories 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.

      • listHistoriesRecordIterator

        public Iterable<HistorySummary> listHistoriesRecordIterator​(ListHistoriesRequest request)
        Creates a new iterable which will iterate over the HistorySummary objects contained in responses from the listHistories 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 HistorySummary objects contained in responses received from the service.

      • listProfileLevelsResponseIterator

        public Iterable<ListProfileLevelsResponse> listProfileLevelsResponseIterator​(ListProfileLevelsRequest request)
        Creates a new iterable which will iterate over the responses received from the listProfileLevels 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.

      • listProfileLevelsRecordIterator

        public Iterable<ProfileLevelSummary> listProfileLevelsRecordIterator​(ListProfileLevelsRequest request)
        Creates a new iterable which will iterate over the ProfileLevelSummary objects contained in responses from the listProfileLevels 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 ProfileLevelSummary objects contained in responses received from the service.

      • listProfilesResponseIterator

        public Iterable<ListProfilesResponse> listProfilesResponseIterator​(ListProfilesRequest request)
        Creates a new iterable which will iterate over the responses received from the listProfiles 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.

      • listProfilesRecordIterator

        public Iterable<ProfileSummary> listProfilesRecordIterator​(ListProfilesRequest request)
        Creates a new iterable which will iterate over the ProfileSummary objects contained in responses from the listProfiles 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 ProfileSummary objects contained in responses received from the service.

      • listRecommendationStrategiesResponseIterator

        public Iterable<ListRecommendationStrategiesResponse> listRecommendationStrategiesResponseIterator​(ListRecommendationStrategiesRequest request)
        Creates a new iterable which will iterate over the responses received from the listRecommendationStrategies 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.

      • listRecommendationsResponseIterator

        public Iterable<ListRecommendationsResponse> listRecommendationsResponseIterator​(ListRecommendationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listRecommendations 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.

      • listRecommendationsRecordIterator

        public Iterable<RecommendationSummary> listRecommendationsRecordIterator​(ListRecommendationsRequest request)
        Creates a new iterable which will iterate over the RecommendationSummary objects contained in responses from the listRecommendations 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 RecommendationSummary objects contained in responses received from the service.

      • listResourceActionQueryableFieldsResponseIterator

        public Iterable<ListResourceActionQueryableFieldsResponse> listResourceActionQueryableFieldsResponseIterator​(ListResourceActionQueryableFieldsRequest request)
        Creates a new iterable which will iterate over the responses received from the listResourceActionQueryableFields 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.

      • listResourceActionQueryableFieldsRecordIterator

        public Iterable<QueryableFieldSummary> listResourceActionQueryableFieldsRecordIterator​(ListResourceActionQueryableFieldsRequest request)
        Creates a new iterable which will iterate over the QueryableFieldSummary objects contained in responses from the listResourceActionQueryableFields 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 QueryableFieldSummary objects contained in responses received from the service.

      • listResourceActionsResponseIterator

        public Iterable<ListResourceActionsResponse> listResourceActionsResponseIterator​(ListResourceActionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listResourceActions 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.

      • listResourceActionsRecordIterator

        public Iterable<ResourceActionSummary> listResourceActionsRecordIterator​(ListResourceActionsRequest request)
        Creates a new iterable which will iterate over the ResourceActionSummary objects contained in responses from the listResourceActions 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 ResourceActionSummary 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<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.

        Parameters:
        request - a request which can be sent to the service operation
        Returns:
        an Iterable which can be used to iterate over the WorkRequest objects contained in responses received from the service.