Show / Hide Table of Contents

Class GoldenGatePaginators

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

Constructors

GoldenGatePaginators(GoldenGateClient)

Declaration
public GoldenGatePaginators(GoldenGateClient client)
Parameters
Type Name Description
GoldenGateClient client

Methods

ListCertificatesRecordEnumerator(ListCertificatesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCertificatesResponseEnumerator(ListCertificatesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConnectionAssignmentsRecordEnumerator(ListConnectionAssignmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConnectionAssignmentsResponseEnumerator(ListConnectionAssignmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseRegistrationsRecordEnumerator(ListDatabaseRegistrationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseRegistrationsResponseEnumerator(ListDatabaseRegistrationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentBackupsRecordEnumerator(ListDeploymentBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentBackupsResponseEnumerator(ListDeploymentBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentEnvironmentsRecordEnumerator(ListDeploymentEnvironmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentEnvironmentsResponseEnumerator(ListDeploymentEnvironmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentPeersRecordEnumerator(ListDeploymentPeersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentPeersResponseEnumerator(ListDeploymentPeersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentTypesRecordEnumerator(ListDeploymentTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentTypesResponseEnumerator(ListDeploymentTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentUpgradesRecordEnumerator(ListDeploymentUpgradesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentUpgradesResponseEnumerator(ListDeploymentUpgradesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentVersionsRecordEnumerator(ListDeploymentVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentVersionsResponseEnumerator(ListDeploymentVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentWalletsOperationsRecordEnumerator(ListDeploymentWalletsOperationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentWalletsOperationsResponseEnumerator(ListDeploymentWalletsOperationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentsRecordEnumerator(ListDeploymentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDeploymentsResponseEnumerator(ListDeploymentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelineRunningProcessesRecordEnumerator(ListPipelineRunningProcessesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelineRunningProcessesResponseEnumerator(ListPipelineRunningProcessesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelineSchemaTablesRecordEnumerator(ListPipelineSchemaTablesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelineSchemaTablesResponseEnumerator(ListPipelineSchemaTablesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelineSchemasRecordEnumerator(ListPipelineSchemasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelineSchemasResponseEnumerator(ListPipelineSchemasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelinesRecordEnumerator(ListPipelinesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPipelinesResponseEnumerator(ListPipelinesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListRecipesRecordEnumerator(ListRecipesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListRecipesResponseEnumerator(ListRecipesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTrailFilesRecordEnumerator(ListTrailFilesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTrailFilesResponseEnumerator(ListTrailFilesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTrailSequencesRecordEnumerator(ListTrailSequencesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTrailSequencesResponseEnumerator(ListTrailSequencesRequest, RetryConfiguration, CancellationToken)

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

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

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