Show / Hide Table of Contents

Class DataCatalogPaginators

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

Constructors

DataCatalogPaginators(DataCatalogClient)

Declaration
public DataCatalogPaginators(DataCatalogClient client)
Parameters
Type Name Description
DataCatalogClient client

Methods

ListAttributeTagsRecordEnumerator(ListAttributeTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAttributeTagsResponseEnumerator(ListAttributeTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAttributesRecordEnumerator(ListAttributesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAttributesResponseEnumerator(ListAttributesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCatalogPrivateEndpointsRecordEnumerator(ListCatalogPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCatalogPrivateEndpointsResponseEnumerator(ListCatalogPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCatalogsRecordEnumerator(ListCatalogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCatalogsResponseEnumerator(ListCatalogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConnectionsRecordEnumerator(ListConnectionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConnectionsResponseEnumerator(ListConnectionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCustomPropertiesRecordEnumerator(ListCustomPropertiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCustomPropertiesResponseEnumerator(ListCustomPropertiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDataAssetTagsRecordEnumerator(ListDataAssetTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDataAssetTagsResponseEnumerator(ListDataAssetTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDataAssetsRecordEnumerator(ListDataAssetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDataAssetsResponseEnumerator(ListDataAssetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListEntitiesRecordEnumerator(ListEntitiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListEntitiesResponseEnumerator(ListEntitiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListEntityTagsRecordEnumerator(ListEntityTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListEntityTagsResponseEnumerator(ListEntityTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFolderTagsRecordEnumerator(ListFolderTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFolderTagsResponseEnumerator(ListFolderTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFoldersRecordEnumerator(ListFoldersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFoldersResponseEnumerator(ListFoldersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListGlossariesRecordEnumerator(ListGlossariesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListGlossariesResponseEnumerator(ListGlossariesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobDefinitionsRecordEnumerator(ListJobDefinitionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobDefinitionsResponseEnumerator(ListJobDefinitionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobExecutionsRecordEnumerator(ListJobExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobExecutionsResponseEnumerator(ListJobExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobLogsRecordEnumerator(ListJobLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobLogsResponseEnumerator(ListJobLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobMetricsRecordEnumerator(ListJobMetricsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobMetricsResponseEnumerator(ListJobMetricsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobsRecordEnumerator(ListJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobsResponseEnumerator(ListJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMetastoresRecordEnumerator(ListMetastoresRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMetastoresResponseEnumerator(ListMetastoresRequest, RetryConfiguration, CancellationToken)

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

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

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

ListNamespacesRecordEnumerator(ListNamespacesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListNamespacesResponseEnumerator(ListNamespacesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPatternsRecordEnumerator(ListPatternsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPatternsResponseEnumerator(ListPatternsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListRulesRecordEnumerator(ListRulesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListRulesResponseEnumerator(ListRulesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTagsRecordEnumerator(ListTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTagsResponseEnumerator(ListTagsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTermRelationshipsRecordEnumerator(ListTermRelationshipsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTermRelationshipsResponseEnumerator(ListTermRelationshipsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTermsRecordEnumerator(ListTermsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTermsResponseEnumerator(ListTermsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTypesRecordEnumerator(ListTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTypesResponseEnumerator(ListTypesRequest, RetryConfiguration, CancellationToken)

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

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

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 WorkRequestLog objects contained in responses from the ListWorkRequestLogs operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequestLog> 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<WorkRequestLog>

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 WorkRequest objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequest> 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<WorkRequest>

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