Class DataFlowPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of DataFlow 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

DataFlowPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DataflowService

Assembly: OCI.DotNetSDK.Dataflow.dll

Syntax

public class DataFlowPaginators

Constructors

DataFlowPaginators(DataFlowClient)

Declaration

public DataFlowPaginators(DataFlowClient client)

Parameters

Type	Name	Description
DataFlowClient	client

Methods

ListApplicationsRecordEnumerator(ListApplicationsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ApplicationSummary> ListApplicationsRecordEnumerator(ListApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListApplicationsRequest	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<ApplicationSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListApplicationsResponseEnumerator(ListApplicationsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListApplicationsResponse> ListApplicationsResponseEnumerator(ListApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListApplicationsRequest	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<ListApplicationsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListPoolsRecordEnumerator(ListPoolsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<PoolSummary> ListPoolsRecordEnumerator(ListPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListPoolsRequest	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<PoolSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListPoolsResponseEnumerator(ListPoolsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListPoolsResponse> ListPoolsResponseEnumerator(ListPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListPoolsRequest	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<ListPoolsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListPrivateEndpointsRecordEnumerator(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<PrivateEndpointSummary> ListPrivateEndpointsRecordEnumerator(ListPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListPrivateEndpointsRequest	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<PrivateEndpointSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListPrivateEndpointsResponseEnumerator(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListPrivateEndpointsResponse> ListPrivateEndpointsResponseEnumerator(ListPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListPrivateEndpointsRequest	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<ListPrivateEndpointsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRunLogsRecordEnumerator(ListRunLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<RunLogSummary> ListRunLogsRecordEnumerator(ListRunLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRunLogsRequest	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<RunLogSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRunLogsResponseEnumerator(ListRunLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListRunLogsResponse> ListRunLogsResponseEnumerator(ListRunLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRunLogsRequest	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<ListRunLogsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRunsRecordEnumerator(ListRunsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<RunSummary> ListRunsRecordEnumerator(ListRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRunsRequest	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<RunSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRunsResponseEnumerator(ListRunsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListRunsResponse> ListRunsResponseEnumerator(ListRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRunsRequest	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<ListRunsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlEndpointsRecordEnumerator(ListSqlEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SqlEndpointSummary> ListSqlEndpointsRecordEnumerator(ListSqlEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlEndpointsRequest	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<SqlEndpointSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlEndpointsResponseEnumerator(ListSqlEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSqlEndpointsResponse> ListSqlEndpointsResponseEnumerator(ListSqlEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlEndpointsRequest	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<ListSqlEndpointsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListStatementsRecordEnumerator(ListStatementsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<StatementSummary> ListStatementsRecordEnumerator(ListStatementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListStatementsRequest	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<StatementSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListStatementsResponseEnumerator(ListStatementsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListStatementsResponse> ListStatementsResponseEnumerator(ListStatementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListStatementsRequest	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<ListStatementsResponse>	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 WorkRequestSummary objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<WorkRequestSummary> ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<WorkRequestSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListWorkRequestsResponse> ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListWorkRequestsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type