Show / Hide Table of Contents

Class PrivateServiceAccessPaginators

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

Constructors

PrivateServiceAccessPaginators(PrivateServiceAccessClient)

Declaration
public PrivateServiceAccessPaginators(PrivateServiceAccessClient client)
Parameters
Type Name Description
PrivateServiceAccessClient client

Methods

ListPrivateServiceAccessesRecordEnumerator(ListPrivateServiceAccessesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateServiceAccessesResponseEnumerator(ListPrivateServiceAccessesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPsaServicesRecordEnumerator(ListPsaServicesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPsaServicesResponseEnumerator(ListPsaServicesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPsaWorkRequestErrorsRecordEnumerator(ListPsaWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

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

ListPsaWorkRequestErrorsResponseEnumerator(ListPsaWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPsaWorkRequestLogsRecordEnumerator(ListPsaWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

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

ListPsaWorkRequestLogsResponseEnumerator(ListPsaWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPsaWorkRequestsRecordEnumerator(ListPsaWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

ListPsaWorkRequestsResponseEnumerator(ListPsaWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top