Class GenerativeAiAgentPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of GenerativeAiAgent where multiple pages of data may be fetched. Two styles of enumerators are supported:

  • Enumerating over the Response objects returned by the list operation. These are referred to as ResponseEnumerators, and the methods are suffixed with ResponseEnumerator. For example: listUsersResponseEnumerator.
  • Enumerating over the resources/records being listed. These are referred to as RecordEnumerators, and the methods are suffixed with RecordEnumerator. For example: listUsersRecordEnumerator.
These enumerators 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 iterator returned by calling a ResponseEnumerator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the enumerables returned by calling a RecordEnumerator 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.
Inheritance
object
GenerativeAiAgentPaginators
Inherited Members
Namespace: Oci.GenerativeaiagentService
Assembly: OCI.DotNetSDK.Generativeaiagent.dll
Syntax
public class GenerativeAiAgentPaginators

Constructors

GenerativeAiAgentPaginators(GenerativeAiAgentClient)

Declaration
public GenerativeAiAgentPaginators(GenerativeAiAgentClient client)
Parameters
Type Name Description
GenerativeAiAgentClient client

Methods

ListAgentEndpointsRecordEnumerator(ListAgentEndpointsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the AgentEndpointSummary objects contained in responses from the ListAgentEndpoints operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<AgentEndpointSummary> ListAgentEndpointsRecordEnumerator(ListAgentEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListAgentEndpointsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<AgentEndpointSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListAgentEndpointsResponseEnumerator(ListAgentEndpointsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListAgentEndpoints operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListAgentEndpointsResponse> ListAgentEndpointsResponseEnumerator(ListAgentEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListAgentEndpointsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListAgentEndpointsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListAgentsRecordEnumerator(ListAgentsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the AgentSummary objects contained in responses from the ListAgents operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<AgentSummary> ListAgentsRecordEnumerator(ListAgentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListAgentsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<AgentSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListAgentsResponseEnumerator(ListAgentsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListAgents operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListAgentsResponse> ListAgentsResponseEnumerator(ListAgentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListAgentsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListAgentsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListDataIngestionJobsRecordEnumerator(ListDataIngestionJobsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the DataIngestionJobSummary objects contained in responses from the ListDataIngestionJobs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<DataIngestionJobSummary> ListDataIngestionJobsRecordEnumerator(ListDataIngestionJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDataIngestionJobsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<DataIngestionJobSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListDataIngestionJobsResponseEnumerator(ListDataIngestionJobsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListDataIngestionJobs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListDataIngestionJobsResponse> ListDataIngestionJobsResponseEnumerator(ListDataIngestionJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDataIngestionJobsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListDataIngestionJobsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListDataSourcesRecordEnumerator(ListDataSourcesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the DataSourceSummary objects contained in responses from the ListDataSources operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<DataSourceSummary> ListDataSourcesRecordEnumerator(ListDataSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDataSourcesRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<DataSourceSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListDataSourcesResponseEnumerator(ListDataSourcesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListDataSources operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListDataSourcesResponse> ListDataSourcesResponseEnumerator(ListDataSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDataSourcesRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListDataSourcesResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListKnowledgeBasesRecordEnumerator(ListKnowledgeBasesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the KnowledgeBaseSummary objects contained in responses from the ListKnowledgeBases operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<KnowledgeBaseSummary> ListKnowledgeBasesRecordEnumerator(ListKnowledgeBasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListKnowledgeBasesRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<KnowledgeBaseSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListKnowledgeBasesResponseEnumerator(ListKnowledgeBasesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListKnowledgeBases operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListKnowledgeBasesResponse> ListKnowledgeBasesResponseEnumerator(ListKnowledgeBasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListKnowledgeBasesRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListKnowledgeBasesResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListToolsRecordEnumerator(ListToolsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the ToolSummary objects contained in responses from the ListTools operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ToolSummary> ListToolsRecordEnumerator(ListToolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListToolsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ToolSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListToolsResponseEnumerator(ListToolsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListTools operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListToolsResponse> ListToolsResponseEnumerator(ListToolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListToolsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListToolsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestError objects contained in responses from the ListWorkRequestErrors operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestError> ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestError>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequestErrors operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestErrorsResponse> ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestErrorsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestLogEntry objects contained in responses from the ListWorkRequestLogs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestLogEntry> ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestLogEntry>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequestLogs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestLogsResponse> ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestLogsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequestSummary objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestSummary> ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<WorkRequestSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<ListWorkRequestsResponse> ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send
RetryConfiguration retryConfiguration

The configuration for retrying, may be null
CancellationToken cancellationToken

The cancellation token object
Returns
Type Description
IEnumerable<ListWorkRequestsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type