Class ServiceCatalogPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of ServiceCatalog 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
ServiceCatalogPaginators
Inherited Members
Namespace: Oci.ServicecatalogService
Assembly: OCI.DotNetSDK.Servicecatalog.dll
Syntax
public class ServiceCatalogPaginators

Constructors

ServiceCatalogPaginators(ServiceCatalogClient)

Declaration
public ServiceCatalogPaginators(ServiceCatalogClient client)
Parameters
Type Name Description
ServiceCatalogClient 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

ListPrivateApplicationPackagesRecordEnumerator(ListPrivateApplicationPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateApplicationPackagesResponseEnumerator(ListPrivateApplicationPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateApplicationsRecordEnumerator(ListPrivateApplicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateApplicationsResponseEnumerator(ListPrivateApplicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListServiceCatalogAssociationsRecordEnumerator(ListServiceCatalogAssociationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListServiceCatalogAssociationsResponseEnumerator(ListServiceCatalogAssociationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListServiceCatalogsRecordEnumerator(ListServiceCatalogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListServiceCatalogsResponseEnumerator(ListServiceCatalogsRequest, RetryConfiguration, CancellationToken)

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

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

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