Package com.oracle.bmc.core

Class ComputePaginators

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

      • ComputePaginators

        public ComputePaginators​(Compute client)

    • Method Detail

      • listAppCatalogListingResourceVersionsResponseIterator

        public Iterable<ListAppCatalogListingResourceVersionsResponse> listAppCatalogListingResourceVersionsResponseIterator​(ListAppCatalogListingResourceVersionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAppCatalogListingResourceVersions 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.

      • listAppCatalogListingsResponseIterator

        public Iterable<ListAppCatalogListingsResponse> listAppCatalogListingsResponseIterator​(ListAppCatalogListingsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAppCatalogListings 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.

      • listAppCatalogListingsRecordIterator

        public Iterable<AppCatalogListingSummary> listAppCatalogListingsRecordIterator​(ListAppCatalogListingsRequest request)
        Creates a new iterable which will iterate over the AppCatalogListingSummary objects contained in responses from the listAppCatalogListings 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 AppCatalogListingSummary objects contained in responses received from the service.

      • listAppCatalogSubscriptionsResponseIterator

        public Iterable<ListAppCatalogSubscriptionsResponse> listAppCatalogSubscriptionsResponseIterator​(ListAppCatalogSubscriptionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAppCatalogSubscriptions 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.

      • listBootVolumeAttachmentsResponseIterator

        public Iterable<ListBootVolumeAttachmentsResponse> listBootVolumeAttachmentsResponseIterator​(ListBootVolumeAttachmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBootVolumeAttachments 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.

      • listBootVolumeAttachmentsRecordIterator

        public Iterable<BootVolumeAttachment> listBootVolumeAttachmentsRecordIterator​(ListBootVolumeAttachmentsRequest request)
        Creates a new iterable which will iterate over the BootVolumeAttachment objects contained in responses from the listBootVolumeAttachments 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 BootVolumeAttachment objects contained in responses received from the service.

      • listComputeCapacityReservationInstanceShapesResponseIterator

        public Iterable<ListComputeCapacityReservationInstanceShapesResponse> listComputeCapacityReservationInstanceShapesResponseIterator​(ListComputeCapacityReservationInstanceShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeCapacityReservationInstanceShapes 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.

      • listComputeCapacityReservationInstancesResponseIterator

        public Iterable<ListComputeCapacityReservationInstancesResponse> listComputeCapacityReservationInstancesResponseIterator​(ListComputeCapacityReservationInstancesRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeCapacityReservationInstances 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.

      • listComputeCapacityReservationsResponseIterator

        public Iterable<ListComputeCapacityReservationsResponse> listComputeCapacityReservationsResponseIterator​(ListComputeCapacityReservationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeCapacityReservations 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.

      • listComputeCapacityTopologiesResponseIterator

        public Iterable<ListComputeCapacityTopologiesResponse> listComputeCapacityTopologiesResponseIterator​(ListComputeCapacityTopologiesRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeCapacityTopologies 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.

      • listComputeCapacityTopologyComputeBareMetalHostsResponseIterator

        public Iterable<ListComputeCapacityTopologyComputeBareMetalHostsResponse> listComputeCapacityTopologyComputeBareMetalHostsResponseIterator​(ListComputeCapacityTopologyComputeBareMetalHostsRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeCapacityTopologyComputeBareMetalHosts 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.

      • listComputeCapacityTopologyComputeHpcIslandsResponseIterator

        public Iterable<ListComputeCapacityTopologyComputeHpcIslandsResponse> listComputeCapacityTopologyComputeHpcIslandsResponseIterator​(ListComputeCapacityTopologyComputeHpcIslandsRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeCapacityTopologyComputeHpcIslands 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.

      • listComputeCapacityTopologyComputeNetworkBlocksResponseIterator

        public Iterable<ListComputeCapacityTopologyComputeNetworkBlocksResponse> listComputeCapacityTopologyComputeNetworkBlocksResponseIterator​(ListComputeCapacityTopologyComputeNetworkBlocksRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeCapacityTopologyComputeNetworkBlocks 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.

      • listComputeClustersResponseIterator

        public Iterable<ListComputeClustersResponse> listComputeClustersResponseIterator​(ListComputeClustersRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeClusters 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.

      • listComputeClustersRecordIterator

        public Iterable<ComputeClusterSummary> listComputeClustersRecordIterator​(ListComputeClustersRequest request)
        Creates a new iterable which will iterate over the ComputeClusterSummary objects contained in responses from the listComputeClusters 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 ComputeClusterSummary objects contained in responses received from the service.

      • listComputeGlobalImageCapabilitySchemaVersionsResponseIterator

        public Iterable<ListComputeGlobalImageCapabilitySchemaVersionsResponse> listComputeGlobalImageCapabilitySchemaVersionsResponseIterator​(ListComputeGlobalImageCapabilitySchemaVersionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeGlobalImageCapabilitySchemaVersions 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.

      • listComputeGlobalImageCapabilitySchemasResponseIterator

        public Iterable<ListComputeGlobalImageCapabilitySchemasResponse> listComputeGlobalImageCapabilitySchemasResponseIterator​(ListComputeGlobalImageCapabilitySchemasRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeGlobalImageCapabilitySchemas 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.

      • listComputeGpuMemoryClusterInstancesResponseIterator

        public Iterable<ListComputeGpuMemoryClusterInstancesResponse> listComputeGpuMemoryClusterInstancesResponseIterator​(ListComputeGpuMemoryClusterInstancesRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeGpuMemoryClusterInstances 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.

      • listComputeGpuMemoryClustersResponseIterator

        public Iterable<ListComputeGpuMemoryClustersResponse> listComputeGpuMemoryClustersResponseIterator​(ListComputeGpuMemoryClustersRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeGpuMemoryClusters 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.

      • listComputeGpuMemoryFabricsResponseIterator

        public Iterable<ListComputeGpuMemoryFabricsResponse> listComputeGpuMemoryFabricsResponseIterator​(ListComputeGpuMemoryFabricsRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeGpuMemoryFabrics 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.

      • listComputeHostGroupsResponseIterator

        public Iterable<ListComputeHostGroupsResponse> listComputeHostGroupsResponseIterator​(ListComputeHostGroupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeHostGroups 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.

      • listComputeHostGroupsRecordIterator

        public Iterable<ComputeHostGroupSummary> listComputeHostGroupsRecordIterator​(ListComputeHostGroupsRequest request)
        Creates a new iterable which will iterate over the ComputeHostGroupSummary objects contained in responses from the listComputeHostGroups 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 ComputeHostGroupSummary objects contained in responses received from the service.

      • listComputeHostsResponseIterator

        public Iterable<ListComputeHostsResponse> listComputeHostsResponseIterator​(ListComputeHostsRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeHosts 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.

      • listComputeHostsRecordIterator

        public Iterable<ComputeHostSummary> listComputeHostsRecordIterator​(ListComputeHostsRequest request)
        Creates a new iterable which will iterate over the ComputeHostSummary objects contained in responses from the listComputeHosts 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 ComputeHostSummary objects contained in responses received from the service.

      • listComputeImageCapabilitySchemasResponseIterator

        public Iterable<ListComputeImageCapabilitySchemasResponse> listComputeImageCapabilitySchemasResponseIterator​(ListComputeImageCapabilitySchemasRequest request)
        Creates a new iterable which will iterate over the responses received from the listComputeImageCapabilitySchemas 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.

      • listConsoleHistoriesResponseIterator

        public Iterable<ListConsoleHistoriesResponse> listConsoleHistoriesResponseIterator​(ListConsoleHistoriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listConsoleHistories 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.

      • listConsoleHistoriesRecordIterator

        public Iterable<ConsoleHistory> listConsoleHistoriesRecordIterator​(ListConsoleHistoriesRequest request)
        Creates a new iterable which will iterate over the ConsoleHistory objects contained in responses from the listConsoleHistories 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 ConsoleHistory objects contained in responses received from the service.

      • listDedicatedVmHostInstanceShapesResponseIterator

        public Iterable<ListDedicatedVmHostInstanceShapesResponse> listDedicatedVmHostInstanceShapesResponseIterator​(ListDedicatedVmHostInstanceShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listDedicatedVmHostInstanceShapes 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.

      • listDedicatedVmHostInstancesResponseIterator

        public Iterable<ListDedicatedVmHostInstancesResponse> listDedicatedVmHostInstancesResponseIterator​(ListDedicatedVmHostInstancesRequest request)
        Creates a new iterable which will iterate over the responses received from the listDedicatedVmHostInstances 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.

      • listDedicatedVmHostShapesResponseIterator

        public Iterable<ListDedicatedVmHostShapesResponse> listDedicatedVmHostShapesResponseIterator​(ListDedicatedVmHostShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listDedicatedVmHostShapes 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.

      • listDedicatedVmHostsResponseIterator

        public Iterable<ListDedicatedVmHostsResponse> listDedicatedVmHostsResponseIterator​(ListDedicatedVmHostsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDedicatedVmHosts 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.

      • listDedicatedVmHostsRecordIterator

        public Iterable<DedicatedVmHostSummary> listDedicatedVmHostsRecordIterator​(ListDedicatedVmHostsRequest request)
        Creates a new iterable which will iterate over the DedicatedVmHostSummary objects contained in responses from the listDedicatedVmHosts 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 DedicatedVmHostSummary objects contained in responses received from the service.

      • listImageShapeCompatibilityEntriesResponseIterator

        public Iterable<ListImageShapeCompatibilityEntriesResponse> listImageShapeCompatibilityEntriesResponseIterator​(ListImageShapeCompatibilityEntriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listImageShapeCompatibilityEntries 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.

      • listImagesResponseIterator

        public Iterable<ListImagesResponse> listImagesResponseIterator​(ListImagesRequest request)
        Creates a new iterable which will iterate over the responses received from the listImages 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.

      • listImagesRecordIterator

        public Iterable<Image> listImagesRecordIterator​(ListImagesRequest request)
        Creates a new iterable which will iterate over the Image objects contained in responses from the listImages 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 Image objects contained in responses received from the service.

      • listInstanceConsoleConnectionsResponseIterator

        public Iterable<ListInstanceConsoleConnectionsResponse> listInstanceConsoleConnectionsResponseIterator​(ListInstanceConsoleConnectionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listInstanceConsoleConnections 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.

      • listInstanceDevicesResponseIterator

        public Iterable<ListInstanceDevicesResponse> listInstanceDevicesResponseIterator​(ListInstanceDevicesRequest request)
        Creates a new iterable which will iterate over the responses received from the listInstanceDevices 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.

      • listInstanceDevicesRecordIterator

        public Iterable<Device> listInstanceDevicesRecordIterator​(ListInstanceDevicesRequest request)
        Creates a new iterable which will iterate over the Device objects contained in responses from the listInstanceDevices 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 Device objects contained in responses received from the service.

      • listInstanceMaintenanceEventsResponseIterator

        public Iterable<ListInstanceMaintenanceEventsResponse> listInstanceMaintenanceEventsResponseIterator​(ListInstanceMaintenanceEventsRequest request)
        Creates a new iterable which will iterate over the responses received from the listInstanceMaintenanceEvents 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.

      • listInstancesResponseIterator

        public Iterable<ListInstancesResponse> listInstancesResponseIterator​(ListInstancesRequest request)
        Creates a new iterable which will iterate over the responses received from the listInstances 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.

      • listInstancesRecordIterator

        public Iterable<Instance> listInstancesRecordIterator​(ListInstancesRequest request)
        Creates a new iterable which will iterate over the Instance objects contained in responses from the listInstances 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 Instance objects contained in responses received from the service.

      • listShapesResponseIterator

        public Iterable<ListShapesResponse> listShapesResponseIterator​(ListShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listShapes 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.

      • listShapesRecordIterator

        public Iterable<Shape> listShapesRecordIterator​(ListShapesRequest request)
        Creates a new iterable which will iterate over the Shape objects contained in responses from the listShapes 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 Shape objects contained in responses received from the service.

      • listVnicAttachmentsResponseIterator

        public Iterable<ListVnicAttachmentsResponse> listVnicAttachmentsResponseIterator​(ListVnicAttachmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listVnicAttachments 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.

      • listVnicAttachmentsRecordIterator

        public Iterable<VnicAttachment> listVnicAttachmentsRecordIterator​(ListVnicAttachmentsRequest request)
        Creates a new iterable which will iterate over the VnicAttachment objects contained in responses from the listVnicAttachments 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 VnicAttachment objects contained in responses received from the service.

      • listVolumeAttachmentsResponseIterator

        public Iterable<ListVolumeAttachmentsResponse> listVolumeAttachmentsResponseIterator​(ListVolumeAttachmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listVolumeAttachments 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.

      • listVolumeAttachmentsRecordIterator

        public Iterable<VolumeAttachment> listVolumeAttachmentsRecordIterator​(ListVolumeAttachmentsRequest request)
        Creates a new iterable which will iterate over the VolumeAttachment objects contained in responses from the listVolumeAttachments 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 VolumeAttachment objects contained in responses received from the service.