Package com.oracle.bmc.identity

Class IdentityPaginators

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

      • IdentityPaginators

        public IdentityPaginators​(Identity client)

    • Method Detail

      • listBulkActionResourceTypesResponseIterator

        public Iterable<ListBulkActionResourceTypesResponse> listBulkActionResourceTypesResponseIterator​(ListBulkActionResourceTypesRequest request)
        Creates a new iterable which will iterate over the responses received from the listBulkActionResourceTypes 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.

      • listBulkActionResourceTypesRecordIterator

        public Iterable<BulkActionResourceType> listBulkActionResourceTypesRecordIterator​(ListBulkActionResourceTypesRequest request)
        Creates a new iterable which will iterate over the BulkActionResourceType objects contained in responses from the listBulkActionResourceTypes 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 BulkActionResourceType objects contained in responses received from the service.

      • listBulkEditTagsResourceTypesResponseIterator

        public Iterable<ListBulkEditTagsResourceTypesResponse> listBulkEditTagsResourceTypesResponseIterator​(ListBulkEditTagsResourceTypesRequest request)
        Creates a new iterable which will iterate over the responses received from the listBulkEditTagsResourceTypes 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.

      • listCompartmentsResponseIterator

        public Iterable<ListCompartmentsResponse> listCompartmentsResponseIterator​(ListCompartmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listCompartments 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.

      • listCompartmentsRecordIterator

        public Iterable<Compartment> listCompartmentsRecordIterator​(ListCompartmentsRequest request)
        Creates a new iterable which will iterate over the Compartment objects contained in responses from the listCompartments 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 Compartment objects contained in responses received from the service.

      • listCostTrackingTagsResponseIterator

        public Iterable<ListCostTrackingTagsResponse> listCostTrackingTagsResponseIterator​(ListCostTrackingTagsRequest request)
        Creates a new iterable which will iterate over the responses received from the listCostTrackingTags 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.

      • listCostTrackingTagsRecordIterator

        public Iterable<Tag> listCostTrackingTagsRecordIterator​(ListCostTrackingTagsRequest request)
        Creates a new iterable which will iterate over the Tag objects contained in responses from the listCostTrackingTags 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 Tag objects contained in responses received from the service.

      • listDbCredentialsResponseIterator

        public Iterable<ListDbCredentialsResponse> listDbCredentialsResponseIterator​(ListDbCredentialsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDbCredentials 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.

      • listDbCredentialsRecordIterator

        public Iterable<DbCredentialSummary> listDbCredentialsRecordIterator​(ListDbCredentialsRequest request)
        Creates a new iterable which will iterate over the DbCredentialSummary objects contained in responses from the listDbCredentials 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 DbCredentialSummary objects contained in responses received from the service.

      • listDomainsResponseIterator

        public Iterable<ListDomainsResponse> listDomainsResponseIterator​(ListDomainsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDomains 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.

      • listDomainsRecordIterator

        public Iterable<DomainSummary> listDomainsRecordIterator​(ListDomainsRequest request)
        Creates a new iterable which will iterate over the DomainSummary objects contained in responses from the listDomains 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 DomainSummary objects contained in responses received from the service.

      • listDynamicGroupsResponseIterator

        public Iterable<ListDynamicGroupsResponse> listDynamicGroupsResponseIterator​(ListDynamicGroupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDynamicGroups 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.

      • listDynamicGroupsRecordIterator

        public Iterable<DynamicGroup> listDynamicGroupsRecordIterator​(ListDynamicGroupsRequest request)
        Creates a new iterable which will iterate over the DynamicGroup objects contained in responses from the listDynamicGroups 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 DynamicGroup objects contained in responses received from the service.

      • listGroupsResponseIterator

        public Iterable<ListGroupsResponse> listGroupsResponseIterator​(ListGroupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listGroups 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.

      • listGroupsRecordIterator

        public Iterable<Group> listGroupsRecordIterator​(ListGroupsRequest request)
        Creates a new iterable which will iterate over the Group objects contained in responses from the listGroups 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 Group objects contained in responses received from the service.

      • listIamWorkRequestErrorsResponseIterator

        public Iterable<ListIamWorkRequestErrorsResponse> listIamWorkRequestErrorsResponseIterator​(ListIamWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listIamWorkRequestErrors 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.

      • listIamWorkRequestLogsResponseIterator

        public Iterable<ListIamWorkRequestLogsResponse> listIamWorkRequestLogsResponseIterator​(ListIamWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listIamWorkRequestLogs 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.

      • listIamWorkRequestLogsRecordIterator

        public Iterable<IamWorkRequestLogSummary> listIamWorkRequestLogsRecordIterator​(ListIamWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the IamWorkRequestLogSummary objects contained in responses from the listIamWorkRequestLogs 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 IamWorkRequestLogSummary objects contained in responses received from the service.

      • listIamWorkRequestsResponseIterator

        public Iterable<ListIamWorkRequestsResponse> listIamWorkRequestsResponseIterator​(ListIamWorkRequestsRequest request)
        Creates a new iterable which will iterate over the responses received from the listIamWorkRequests 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.

      • listIamWorkRequestsRecordIterator

        public Iterable<IamWorkRequestSummary> listIamWorkRequestsRecordIterator​(ListIamWorkRequestsRequest request)
        Creates a new iterable which will iterate over the IamWorkRequestSummary objects contained in responses from the listIamWorkRequests 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 IamWorkRequestSummary objects contained in responses received from the service.

      • listIdentityProviderGroupsResponseIterator

        public Iterable<ListIdentityProviderGroupsResponse> listIdentityProviderGroupsResponseIterator​(ListIdentityProviderGroupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listIdentityProviderGroups 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.

      • listIdentityProvidersResponseIterator

        public Iterable<ListIdentityProvidersResponse> listIdentityProvidersResponseIterator​(ListIdentityProvidersRequest request)
        Creates a new iterable which will iterate over the responses received from the listIdentityProviders 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.

      • listIdentityProvidersRecordIterator

        public Iterable<IdentityProvider> listIdentityProvidersRecordIterator​(ListIdentityProvidersRequest request)
        Creates a new iterable which will iterate over the IdentityProvider objects contained in responses from the listIdentityProviders 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 IdentityProvider objects contained in responses received from the service.

      • listIdpGroupMappingsResponseIterator

        public Iterable<ListIdpGroupMappingsResponse> listIdpGroupMappingsResponseIterator​(ListIdpGroupMappingsRequest request)
        Creates a new iterable which will iterate over the responses received from the listIdpGroupMappings 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.

      • listIdpGroupMappingsRecordIterator

        public Iterable<IdpGroupMapping> listIdpGroupMappingsRecordIterator​(ListIdpGroupMappingsRequest request)
        Creates a new iterable which will iterate over the IdpGroupMapping objects contained in responses from the listIdpGroupMappings 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 IdpGroupMapping objects contained in responses received from the service.

      • listMfaTotpDevicesResponseIterator

        public Iterable<ListMfaTotpDevicesResponse> listMfaTotpDevicesResponseIterator​(ListMfaTotpDevicesRequest request)
        Creates a new iterable which will iterate over the responses received from the listMfaTotpDevices 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.

      • listMfaTotpDevicesRecordIterator

        public Iterable<MfaTotpDeviceSummary> listMfaTotpDevicesRecordIterator​(ListMfaTotpDevicesRequest request)
        Creates a new iterable which will iterate over the MfaTotpDeviceSummary objects contained in responses from the listMfaTotpDevices 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 MfaTotpDeviceSummary objects contained in responses received from the service.

      • listNetworkSourcesResponseIterator

        public Iterable<ListNetworkSourcesResponse> listNetworkSourcesResponseIterator​(ListNetworkSourcesRequest request)
        Creates a new iterable which will iterate over the responses received from the listNetworkSources 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.

      • listNetworkSourcesRecordIterator

        public Iterable<NetworkSourcesSummary> listNetworkSourcesRecordIterator​(ListNetworkSourcesRequest request)
        Creates a new iterable which will iterate over the NetworkSourcesSummary objects contained in responses from the listNetworkSources 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 NetworkSourcesSummary objects contained in responses received from the service.

      • listOAuthClientCredentialsResponseIterator

        public Iterable<ListOAuthClientCredentialsResponse> listOAuthClientCredentialsResponseIterator​(ListOAuthClientCredentialsRequest request)
        Creates a new iterable which will iterate over the responses received from the listOAuthClientCredentials 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.

      • listPoliciesResponseIterator

        public Iterable<ListPoliciesResponse> listPoliciesResponseIterator​(ListPoliciesRequest request)
        Creates a new iterable which will iterate over the responses received from the listPolicies 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.

      • listPoliciesRecordIterator

        public Iterable<Policy> listPoliciesRecordIterator​(ListPoliciesRequest request)
        Creates a new iterable which will iterate over the Policy objects contained in responses from the listPolicies 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 Policy objects contained in responses received from the service.

      • listStandardTagNamespacesResponseIterator

        public Iterable<ListStandardTagNamespacesResponse> listStandardTagNamespacesResponseIterator​(ListStandardTagNamespacesRequest request)
        Creates a new iterable which will iterate over the responses received from the listStandardTagNamespaces 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.

      • listTagDefaultsResponseIterator

        public Iterable<ListTagDefaultsResponse> listTagDefaultsResponseIterator​(ListTagDefaultsRequest request)
        Creates a new iterable which will iterate over the responses received from the listTagDefaults 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.

      • listTagDefaultsRecordIterator

        public Iterable<TagDefaultSummary> listTagDefaultsRecordIterator​(ListTagDefaultsRequest request)
        Creates a new iterable which will iterate over the TagDefaultSummary objects contained in responses from the listTagDefaults 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 TagDefaultSummary objects contained in responses received from the service.

      • listTagNamespacesResponseIterator

        public Iterable<ListTagNamespacesResponse> listTagNamespacesResponseIterator​(ListTagNamespacesRequest request)
        Creates a new iterable which will iterate over the responses received from the listTagNamespaces 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.

      • listTagNamespacesRecordIterator

        public Iterable<TagNamespaceSummary> listTagNamespacesRecordIterator​(ListTagNamespacesRequest request)
        Creates a new iterable which will iterate over the TagNamespaceSummary objects contained in responses from the listTagNamespaces 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 TagNamespaceSummary objects contained in responses received from the service.

      • listTaggingWorkRequestErrorsResponseIterator

        public Iterable<ListTaggingWorkRequestErrorsResponse> listTaggingWorkRequestErrorsResponseIterator​(ListTaggingWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listTaggingWorkRequestErrors 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.

      • listTaggingWorkRequestLogsResponseIterator

        public Iterable<ListTaggingWorkRequestLogsResponse> listTaggingWorkRequestLogsResponseIterator​(ListTaggingWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listTaggingWorkRequestLogs 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.

      • listTaggingWorkRequestsResponseIterator

        public Iterable<ListTaggingWorkRequestsResponse> listTaggingWorkRequestsResponseIterator​(ListTaggingWorkRequestsRequest request)
        Creates a new iterable which will iterate over the responses received from the listTaggingWorkRequests 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.

      • listTagsResponseIterator

        public Iterable<ListTagsResponse> listTagsResponseIterator​(ListTagsRequest request)
        Creates a new iterable which will iterate over the responses received from the listTags 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.

      • listTagsRecordIterator

        public Iterable<TagSummary> listTagsRecordIterator​(ListTagsRequest request)
        Creates a new iterable which will iterate over the TagSummary objects contained in responses from the listTags 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 TagSummary objects contained in responses received from the service.

      • listUserGroupMembershipsResponseIterator

        public Iterable<ListUserGroupMembershipsResponse> listUserGroupMembershipsResponseIterator​(ListUserGroupMembershipsRequest request)
        Creates a new iterable which will iterate over the responses received from the listUserGroupMemberships 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.

      • listUserGroupMembershipsRecordIterator

        public Iterable<UserGroupMembership> listUserGroupMembershipsRecordIterator​(ListUserGroupMembershipsRequest request)
        Creates a new iterable which will iterate over the UserGroupMembership objects contained in responses from the listUserGroupMemberships 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 UserGroupMembership objects contained in responses received from the service.

      • listUsersResponseIterator

        public Iterable<ListUsersResponse> listUsersResponseIterator​(ListUsersRequest request)
        Creates a new iterable which will iterate over the responses received from the listUsers 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.

      • listUsersRecordIterator

        public Iterable<User> listUsersRecordIterator​(ListUsersRequest request)
        Creates a new iterable which will iterate over the User objects contained in responses from the listUsers 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 User 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.