Show / Hide Table of Contents

Class GenerativeAiPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of GenerativeAi 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
GenerativeAiPaginators
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiService
Assembly: OCI.DotNetSDK.Generativeai.dll
Syntax
public class GenerativeAiPaginators

Constructors

GenerativeAiPaginators(GenerativeAiClient)

Declaration
public GenerativeAiPaginators(GenerativeAiClient client)
Parameters
Type Name Description
GenerativeAiClient client

Methods

ListApiKeysRecordEnumerator(ListApiKeysRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ApiKeySummary> ListApiKeysRecordEnumerator(ListApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListApiKeysRequest 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<ApiKeySummary>

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

ListApiKeysResponseEnumerator(ListApiKeysRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListApiKeysResponse> ListApiKeysResponseEnumerator(ListApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListApiKeysRequest 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<ListApiKeysResponse>

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

ListDedicatedAiClustersRecordEnumerator(ListDedicatedAiClustersRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<DedicatedAiClusterSummary> ListDedicatedAiClustersRecordEnumerator(ListDedicatedAiClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDedicatedAiClustersRequest 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<DedicatedAiClusterSummary>

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

ListDedicatedAiClustersResponseEnumerator(ListDedicatedAiClustersRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListDedicatedAiClustersResponse> ListDedicatedAiClustersResponseEnumerator(ListDedicatedAiClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDedicatedAiClustersRequest 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<ListDedicatedAiClustersResponse>

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

ListEndpointsRecordEnumerator(ListEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<EndpointSummary> ListEndpointsRecordEnumerator(ListEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListEndpointsRequest 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<EndpointSummary>

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

ListEndpointsResponseEnumerator(ListEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListEndpointsResponse> ListEndpointsResponseEnumerator(ListEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListEndpointsRequest 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<ListEndpointsResponse>

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

ListGenerativeAiPrivateEndpointsRecordEnumerator(ListGenerativeAiPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<GenerativeAiPrivateEndpointSummary> ListGenerativeAiPrivateEndpointsRecordEnumerator(ListGenerativeAiPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListGenerativeAiPrivateEndpointsRequest 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<GenerativeAiPrivateEndpointSummary>

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

ListGenerativeAiPrivateEndpointsResponseEnumerator(ListGenerativeAiPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListGenerativeAiPrivateEndpointsResponse> ListGenerativeAiPrivateEndpointsResponseEnumerator(ListGenerativeAiPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListGenerativeAiPrivateEndpointsRequest 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<ListGenerativeAiPrivateEndpointsResponse>

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

ListGenerativeAiProjectsRecordEnumerator(ListGenerativeAiProjectsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<GenerativeAiProjectSummary> ListGenerativeAiProjectsRecordEnumerator(ListGenerativeAiProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListGenerativeAiProjectsRequest 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<GenerativeAiProjectSummary>

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

ListGenerativeAiProjectsResponseEnumerator(ListGenerativeAiProjectsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListGenerativeAiProjectsResponse> ListGenerativeAiProjectsResponseEnumerator(ListGenerativeAiProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListGenerativeAiProjectsRequest 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<ListGenerativeAiProjectsResponse>

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

ListHostedApplicationStoragesRecordEnumerator(ListHostedApplicationStoragesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<HostedApplicationStorageSummary> ListHostedApplicationStoragesRecordEnumerator(ListHostedApplicationStoragesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListHostedApplicationStoragesRequest 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<HostedApplicationStorageSummary>

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

ListHostedApplicationStoragesResponseEnumerator(ListHostedApplicationStoragesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListHostedApplicationStoragesResponse> ListHostedApplicationStoragesResponseEnumerator(ListHostedApplicationStoragesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListHostedApplicationStoragesRequest 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<ListHostedApplicationStoragesResponse>

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

ListHostedApplicationsRecordEnumerator(ListHostedApplicationsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<HostedApplicationSummary> ListHostedApplicationsRecordEnumerator(ListHostedApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListHostedApplicationsRequest 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<HostedApplicationSummary>

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

ListHostedApplicationsResponseEnumerator(ListHostedApplicationsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListHostedApplicationsResponse> ListHostedApplicationsResponseEnumerator(ListHostedApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListHostedApplicationsRequest 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<ListHostedApplicationsResponse>

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

ListHostedDeploymentsRecordEnumerator(ListHostedDeploymentsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<HostedDeploymentSummary> ListHostedDeploymentsRecordEnumerator(ListHostedDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListHostedDeploymentsRequest 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<HostedDeploymentSummary>

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

ListHostedDeploymentsResponseEnumerator(ListHostedDeploymentsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListHostedDeploymentsResponse> ListHostedDeploymentsResponseEnumerator(ListHostedDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListHostedDeploymentsRequest 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<ListHostedDeploymentsResponse>

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

ListImportedModelsRecordEnumerator(ListImportedModelsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ImportedModelSummary> ListImportedModelsRecordEnumerator(ListImportedModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListImportedModelsRequest 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<ImportedModelSummary>

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

ListImportedModelsResponseEnumerator(ListImportedModelsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListImportedModelsResponse> ListImportedModelsResponseEnumerator(ListImportedModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListImportedModelsRequest 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<ListImportedModelsResponse>

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

ListModelsRecordEnumerator(ListModelsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ModelSummary> ListModelsRecordEnumerator(ListModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListModelsRequest 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<ModelSummary>

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

ListModelsResponseEnumerator(ListModelsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListModelsResponse> ListModelsResponseEnumerator(ListModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListModelsRequest 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<ListModelsResponse>

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

ListSemanticStoresRecordEnumerator(ListSemanticStoresRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<SemanticStoreSummary> ListSemanticStoresRecordEnumerator(ListSemanticStoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSemanticStoresRequest 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<SemanticStoreSummary>

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

ListSemanticStoresResponseEnumerator(ListSemanticStoresRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListSemanticStoresResponse> ListSemanticStoresResponseEnumerator(ListSemanticStoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSemanticStoresRequest 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<ListSemanticStoresResponse>

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

ListVectorStoreConnectorFileSyncIngestionLogsRecordEnumerator(ListVectorStoreConnectorFileSyncIngestionLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<FileSyncIngestionLogs> ListVectorStoreConnectorFileSyncIngestionLogsRecordEnumerator(ListVectorStoreConnectorFileSyncIngestionLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorFileSyncIngestionLogsRequest 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<FileSyncIngestionLogs>

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

ListVectorStoreConnectorFileSyncIngestionLogsResponseEnumerator(ListVectorStoreConnectorFileSyncIngestionLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListVectorStoreConnectorFileSyncIngestionLogsResponse> ListVectorStoreConnectorFileSyncIngestionLogsResponseEnumerator(ListVectorStoreConnectorFileSyncIngestionLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorFileSyncIngestionLogsRequest 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<ListVectorStoreConnectorFileSyncIngestionLogsResponse>

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

ListVectorStoreConnectorFileSyncsRecordEnumerator(ListVectorStoreConnectorFileSyncsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<VectorStoreConnectorFileSyncSummary> ListVectorStoreConnectorFileSyncsRecordEnumerator(ListVectorStoreConnectorFileSyncsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorFileSyncsRequest 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<VectorStoreConnectorFileSyncSummary>

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

ListVectorStoreConnectorFileSyncsResponseEnumerator(ListVectorStoreConnectorFileSyncsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListVectorStoreConnectorFileSyncsResponse> ListVectorStoreConnectorFileSyncsResponseEnumerator(ListVectorStoreConnectorFileSyncsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorFileSyncsRequest 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<ListVectorStoreConnectorFileSyncsResponse>

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

ListVectorStoreConnectorIngestionLogsRecordEnumerator(ListVectorStoreConnectorIngestionLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<VectorStoreConnectorIngestionLogs> ListVectorStoreConnectorIngestionLogsRecordEnumerator(ListVectorStoreConnectorIngestionLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorIngestionLogsRequest 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<VectorStoreConnectorIngestionLogs>

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

ListVectorStoreConnectorIngestionLogsResponseEnumerator(ListVectorStoreConnectorIngestionLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListVectorStoreConnectorIngestionLogsResponse> ListVectorStoreConnectorIngestionLogsResponseEnumerator(ListVectorStoreConnectorIngestionLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorIngestionLogsRequest 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<ListVectorStoreConnectorIngestionLogsResponse>

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

ListVectorStoreConnectorsRecordEnumerator(ListVectorStoreConnectorsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<VectorStoreConnectorSummary> ListVectorStoreConnectorsRecordEnumerator(ListVectorStoreConnectorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorsRequest 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<VectorStoreConnectorSummary>

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

ListVectorStoreConnectorsResponseEnumerator(ListVectorStoreConnectorsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListVectorStoreConnectorsResponse> ListVectorStoreConnectorsResponseEnumerator(ListVectorStoreConnectorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListVectorStoreConnectorsRequest 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<ListVectorStoreConnectorsResponse>

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

In this article
Back to top