Class ZprPaginators

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

ZprPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ZprService

Assembly: OCI.DotNetSDK.Zpr.dll

Syntax

public class ZprPaginators

Constructors

ZprPaginators(ZprClient)

Declaration

public ZprPaginators(ZprClient client)

Parameters

Type	Name	Description
ZprClient	client

Methods

ListZprConfigurationWorkRequestErrorsRecordEnumerator(ListZprConfigurationWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

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

Parameters

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

ListZprConfigurationWorkRequestErrorsResponseEnumerator(ListZprConfigurationWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZprConfigurationWorkRequestErrorsResponse> ListZprConfigurationWorkRequestErrorsResponseEnumerator(ListZprConfigurationWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZprConfigurationWorkRequestLogsRecordEnumerator(ListZprConfigurationWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

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

Parameters

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

ListZprConfigurationWorkRequestLogsResponseEnumerator(ListZprConfigurationWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZprConfigurationWorkRequestLogsResponse> ListZprConfigurationWorkRequestLogsResponseEnumerator(ListZprConfigurationWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZprConfigurationWorkRequestsRecordEnumerator(ListZprConfigurationWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

Declaration

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

Parameters

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

ListZprConfigurationWorkRequestsResponseEnumerator(ListZprConfigurationWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZprConfigurationWorkRequestsResponse> ListZprConfigurationWorkRequestsResponseEnumerator(ListZprConfigurationWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZprPoliciesRecordEnumerator(ListZprPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ZprPolicySummary> ListZprPoliciesRecordEnumerator(ListZprPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZprPoliciesResponseEnumerator(ListZprPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZprPoliciesResponse> ListZprPoliciesResponseEnumerator(ListZprPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZprPolicyWorkRequestErrorsRecordEnumerator(ListZprPolicyWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

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

Parameters

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

ListZprPolicyWorkRequestErrorsResponseEnumerator(ListZprPolicyWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZprPolicyWorkRequestErrorsResponse> ListZprPolicyWorkRequestErrorsResponseEnumerator(ListZprPolicyWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZprPolicyWorkRequestLogsRecordEnumerator(ListZprPolicyWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

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

Parameters

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

ListZprPolicyWorkRequestLogsResponseEnumerator(ListZprPolicyWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZprPolicyWorkRequestLogsResponse> ListZprPolicyWorkRequestLogsResponseEnumerator(ListZprPolicyWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZprPolicyWorkRequestsRecordEnumerator(ListZprPolicyWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

Declaration

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

Parameters

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

ListZprPolicyWorkRequestsResponseEnumerator(ListZprPolicyWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZprPolicyWorkRequestsResponse> ListZprPolicyWorkRequestsResponseEnumerator(ListZprPolicyWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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