Class GuardedDataPipelinePaginators

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

GuardedDataPipelinePaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GdpService

Assembly: OCI.DotNetSDK.Gdp.dll

Syntax

public class GuardedDataPipelinePaginators

Constructors

GuardedDataPipelinePaginators(GuardedDataPipelineClient)

Declaration

public GuardedDataPipelinePaginators(GuardedDataPipelineClient client)

Parameters

Type	Name	Description
GuardedDataPipelineClient	client

Methods

ListGdpPipelinesRecordEnumerator(ListGdpPipelinesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<GdpPipelineSummary> ListGdpPipelinesRecordEnumerator(ListGdpPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListGdpPipelinesResponseEnumerator(ListGdpPipelinesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListGdpPipelinesResponse> ListGdpPipelinesResponseEnumerator(ListGdpPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListGdpWorkRequestErrorsRecordEnumerator(ListGdpWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<WorkRequestError> ListGdpWorkRequestErrorsRecordEnumerator(ListGdpWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListGdpWorkRequestErrorsRequest	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

ListGdpWorkRequestErrorsResponseEnumerator(ListGdpWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListGdpWorkRequestErrorsResponse> ListGdpWorkRequestErrorsResponseEnumerator(ListGdpWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListGdpWorkRequestLogsRecordEnumerator(ListGdpWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<WorkRequestLogEntry> ListGdpWorkRequestLogsRecordEnumerator(ListGdpWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListGdpWorkRequestLogsRequest	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

ListGdpWorkRequestLogsResponseEnumerator(ListGdpWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListGdpWorkRequestLogsResponse> ListGdpWorkRequestLogsResponseEnumerator(ListGdpWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListGdpWorkRequestsRecordEnumerator(ListGdpWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<GdpWorkRequestSummary> ListGdpWorkRequestsRecordEnumerator(ListGdpWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListGdpWorkRequestsResponseEnumerator(ListGdpWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListGdpWorkRequestsResponse> ListGdpWorkRequestsResponseEnumerator(ListGdpWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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