Package com.oracle.bmc.generativeaiagent

Class GenerativeAiAgentPaginators

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

      • GenerativeAiAgentPaginators

        public GenerativeAiAgentPaginators​(GenerativeAiAgent client)

    • Method Detail

      • listAgentEndpointsResponseIterator

        public Iterable<ListAgentEndpointsResponse> listAgentEndpointsResponseIterator​(ListAgentEndpointsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAgentEndpoints 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.

      • listAgentEndpointsRecordIterator

        public Iterable<AgentEndpointSummary> listAgentEndpointsRecordIterator​(ListAgentEndpointsRequest request)
        Creates a new iterable which will iterate over the AgentEndpointSummary objects contained in responses from the listAgentEndpoints 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 AgentEndpointSummary objects contained in responses received from the service.

      • listAgentsResponseIterator

        public Iterable<ListAgentsResponse> listAgentsResponseIterator​(ListAgentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAgents 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.

      • listAgentsRecordIterator

        public Iterable<AgentSummary> listAgentsRecordIterator​(ListAgentsRequest request)
        Creates a new iterable which will iterate over the AgentSummary objects contained in responses from the listAgents 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 AgentSummary objects contained in responses received from the service.

      • listDataIngestionJobsResponseIterator

        public Iterable<ListDataIngestionJobsResponse> listDataIngestionJobsResponseIterator​(ListDataIngestionJobsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDataIngestionJobs 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.

      • listDataIngestionJobsRecordIterator

        public Iterable<DataIngestionJobSummary> listDataIngestionJobsRecordIterator​(ListDataIngestionJobsRequest request)
        Creates a new iterable which will iterate over the DataIngestionJobSummary objects contained in responses from the listDataIngestionJobs 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 DataIngestionJobSummary objects contained in responses received from the service.

      • listDataSourcesResponseIterator

        public Iterable<ListDataSourcesResponse> listDataSourcesResponseIterator​(ListDataSourcesRequest request)
        Creates a new iterable which will iterate over the responses received from the listDataSources 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.

      • listDataSourcesRecordIterator

        public Iterable<DataSourceSummary> listDataSourcesRecordIterator​(ListDataSourcesRequest request)
        Creates a new iterable which will iterate over the DataSourceSummary objects contained in responses from the listDataSources 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 DataSourceSummary objects contained in responses received from the service.

      • listKnowledgeBasesResponseIterator

        public Iterable<ListKnowledgeBasesResponse> listKnowledgeBasesResponseIterator​(ListKnowledgeBasesRequest request)
        Creates a new iterable which will iterate over the responses received from the listKnowledgeBases 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.

      • listKnowledgeBasesRecordIterator

        public Iterable<KnowledgeBaseSummary> listKnowledgeBasesRecordIterator​(ListKnowledgeBasesRequest request)
        Creates a new iterable which will iterate over the KnowledgeBaseSummary objects contained in responses from the listKnowledgeBases 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 KnowledgeBaseSummary objects contained in responses received from the service.

      • listToolsResponseIterator

        public Iterable<ListToolsResponse> listToolsResponseIterator​(ListToolsRequest request)
        Creates a new iterable which will iterate over the responses received from the listTools 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.

      • listToolsRecordIterator

        public Iterable<ToolSummary> listToolsRecordIterator​(ListToolsRequest request)
        Creates a new iterable which will iterate over the ToolSummary objects contained in responses from the listTools 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 ToolSummary objects contained in responses received from the service.

      • listWorkRequestErrorsResponseIterator

        public Iterable<ListWorkRequestErrorsResponse> listWorkRequestErrorsResponseIterator​(ListWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequestErrors operation.

        This iterable will fetch more data from the server as needed.

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

      • listWorkRequestErrorsRecordIterator

        public Iterable<WorkRequestError> listWorkRequestErrorsRecordIterator​(ListWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the WorkRequestError objects contained in responses from the listWorkRequestErrors operation.

        This iterable will fetch more data from the server as needed.

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

      • listWorkRequestLogsResponseIterator

        public Iterable<ListWorkRequestLogsResponse> listWorkRequestLogsResponseIterator​(ListWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequestLogs operation.

        This iterable will fetch more data from the server as needed.

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

      • listWorkRequestLogsRecordIterator

        public Iterable<WorkRequestLogEntry> listWorkRequestLogsRecordIterator​(ListWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation.

        This iterable will fetch more data from the server as needed.

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

      • listWorkRequestsResponseIterator

        public Iterable<ListWorkRequestsResponse> listWorkRequestsResponseIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequests operation.

        This iterable will fetch more data from the server as needed.

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

      • listWorkRequestsRecordIterator

        public Iterable<WorkRequestSummary> listWorkRequestsRecordIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the WorkRequestSummary objects contained in responses from the listWorkRequests operation.

        This iterable will fetch more data from the server as needed.

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