Package com.oracle.bmc.generativeai

Class GenerativeAiPaginators

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

      • GenerativeAiPaginators

        public GenerativeAiPaginators​(GenerativeAi client)

    • Method Detail

      • listApiKeysResponseIterator

        public Iterable<ListApiKeysResponse> listApiKeysResponseIterator​(ListApiKeysRequest request)
        Creates a new iterable which will iterate over the responses received from the listApiKeys 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.

      • listApiKeysRecordIterator

        public Iterable<ApiKeySummary> listApiKeysRecordIterator​(ListApiKeysRequest request)
        Creates a new iterable which will iterate over the ApiKeySummary objects contained in responses from the listApiKeys 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 ApiKeySummary objects contained in responses received from the service.

      • listDedicatedAiClustersResponseIterator

        public Iterable<ListDedicatedAiClustersResponse> listDedicatedAiClustersResponseIterator​(ListDedicatedAiClustersRequest request)
        Creates a new iterable which will iterate over the responses received from the listDedicatedAiClusters 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.

      • listEndpointsResponseIterator

        public Iterable<ListEndpointsResponse> listEndpointsResponseIterator​(ListEndpointsRequest request)
        Creates a new iterable which will iterate over the responses received from the listEndpoints 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.

      • listEndpointsRecordIterator

        public Iterable<EndpointSummary> listEndpointsRecordIterator​(ListEndpointsRequest request)
        Creates a new iterable which will iterate over the EndpointSummary objects contained in responses from the listEndpoints 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 EndpointSummary objects contained in responses received from the service.

      • listGenerativeAiPrivateEndpointsResponseIterator

        public Iterable<ListGenerativeAiPrivateEndpointsResponse> listGenerativeAiPrivateEndpointsResponseIterator​(ListGenerativeAiPrivateEndpointsRequest request)
        Creates a new iterable which will iterate over the responses received from the listGenerativeAiPrivateEndpoints 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.

      • listGenerativeAiProjectsResponseIterator

        public Iterable<ListGenerativeAiProjectsResponse> listGenerativeAiProjectsResponseIterator​(ListGenerativeAiProjectsRequest request)
        Creates a new iterable which will iterate over the responses received from the listGenerativeAiProjects 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.

      • listHostedApplicationStoragesResponseIterator

        public Iterable<ListHostedApplicationStoragesResponse> listHostedApplicationStoragesResponseIterator​(ListHostedApplicationStoragesRequest request)
        Creates a new iterable which will iterate over the responses received from the listHostedApplicationStorages 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.

      • listHostedApplicationsResponseIterator

        public Iterable<ListHostedApplicationsResponse> listHostedApplicationsResponseIterator​(ListHostedApplicationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listHostedApplications 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.

      • listHostedApplicationsRecordIterator

        public Iterable<HostedApplicationSummary> listHostedApplicationsRecordIterator​(ListHostedApplicationsRequest request)
        Creates a new iterable which will iterate over the HostedApplicationSummary objects contained in responses from the listHostedApplications 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 HostedApplicationSummary objects contained in responses received from the service.

      • listHostedDeploymentsResponseIterator

        public Iterable<ListHostedDeploymentsResponse> listHostedDeploymentsResponseIterator​(ListHostedDeploymentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listHostedDeployments 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.

      • listHostedDeploymentsRecordIterator

        public Iterable<HostedDeploymentSummary> listHostedDeploymentsRecordIterator​(ListHostedDeploymentsRequest request)
        Creates a new iterable which will iterate over the HostedDeploymentSummary objects contained in responses from the listHostedDeployments 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 HostedDeploymentSummary objects contained in responses received from the service.

      • listImportedModelsResponseIterator

        public Iterable<ListImportedModelsResponse> listImportedModelsResponseIterator​(ListImportedModelsRequest request)
        Creates a new iterable which will iterate over the responses received from the listImportedModels 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.

      • listImportedModelsRecordIterator

        public Iterable<ImportedModelSummary> listImportedModelsRecordIterator​(ListImportedModelsRequest request)
        Creates a new iterable which will iterate over the ImportedModelSummary objects contained in responses from the listImportedModels 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 ImportedModelSummary objects contained in responses received from the service.

      • listModelsResponseIterator

        public Iterable<ListModelsResponse> listModelsResponseIterator​(ListModelsRequest request)
        Creates a new iterable which will iterate over the responses received from the listModels 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.

      • listModelsRecordIterator

        public Iterable<ModelSummary> listModelsRecordIterator​(ListModelsRequest request)
        Creates a new iterable which will iterate over the ModelSummary objects contained in responses from the listModels 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 ModelSummary objects contained in responses received from the service.

      • listSemanticStoresResponseIterator

        public Iterable<ListSemanticStoresResponse> listSemanticStoresResponseIterator​(ListSemanticStoresRequest request)
        Creates a new iterable which will iterate over the responses received from the listSemanticStores 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.

      • listSemanticStoresRecordIterator

        public Iterable<SemanticStoreSummary> listSemanticStoresRecordIterator​(ListSemanticStoresRequest request)
        Creates a new iterable which will iterate over the SemanticStoreSummary objects contained in responses from the listSemanticStores 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 SemanticStoreSummary objects contained in responses received from the service.

      • listVectorStoreConnectorFileSyncIngestionLogsResponseIterator

        public Iterable<ListVectorStoreConnectorFileSyncIngestionLogsResponse> listVectorStoreConnectorFileSyncIngestionLogsResponseIterator​(ListVectorStoreConnectorFileSyncIngestionLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listVectorStoreConnectorFileSyncIngestionLogs 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.

      • listVectorStoreConnectorFileSyncIngestionLogsRecordIterator

        public Iterable<FileSyncIngestionLogs> listVectorStoreConnectorFileSyncIngestionLogsRecordIterator​(ListVectorStoreConnectorFileSyncIngestionLogsRequest request)
        Creates a new iterable which will iterate over the FileSyncIngestionLogs objects contained in responses from the listVectorStoreConnectorFileSyncIngestionLogs 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 FileSyncIngestionLogs objects contained in responses received from the service.

      • listVectorStoreConnectorFileSyncsResponseIterator

        public Iterable<ListVectorStoreConnectorFileSyncsResponse> listVectorStoreConnectorFileSyncsResponseIterator​(ListVectorStoreConnectorFileSyncsRequest request)
        Creates a new iterable which will iterate over the responses received from the listVectorStoreConnectorFileSyncs 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.

      • listVectorStoreConnectorIngestionLogsResponseIterator

        public Iterable<ListVectorStoreConnectorIngestionLogsResponse> listVectorStoreConnectorIngestionLogsResponseIterator​(ListVectorStoreConnectorIngestionLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listVectorStoreConnectorIngestionLogs 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.

      • listVectorStoreConnectorsResponseIterator

        public Iterable<ListVectorStoreConnectorsResponse> listVectorStoreConnectorsResponseIterator​(ListVectorStoreConnectorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listVectorStoreConnectors 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.

      • 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.