Class MarketplacePaginators

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

Constructors

MarketplacePaginators(MarketplaceClient)

Declaration
public MarketplacePaginators(MarketplaceClient client)
Parameters
Type Name Description
MarketplaceClient client

Methods

ListAcceptedAgreementsRecordEnumerator(ListAcceptedAgreementsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAcceptedAgreementsResponseEnumerator(ListAcceptedAgreementsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAgreementsRecordEnumerator(ListAgreementsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAgreementsResponseEnumerator(ListAgreementsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCategoriesRecordEnumerator(ListCategoriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCategoriesResponseEnumerator(ListCategoriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListListingsRecordEnumerator(ListListingsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListListingsResponseEnumerator(ListListingsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPackagesRecordEnumerator(ListPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPackagesResponseEnumerator(ListPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPublicationPackagesRecordEnumerator(ListPublicationPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPublicationPackagesResponseEnumerator(ListPublicationPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPublicationsRecordEnumerator(ListPublicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPublicationsResponseEnumerator(ListPublicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPublishersRecordEnumerator(ListPublishersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPublishersResponseEnumerator(ListPublishersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReportTypesRecordEnumerator(ListReportTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReportTypesResponseEnumerator(ListReportTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReportsRecordEnumerator(ListReportsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReportsResponseEnumerator(ListReportsRequest, RetryConfiguration, CancellationToken)

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

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

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

SearchListingsRecordEnumerator(SearchListingsRequest, RetryConfiguration, CancellationToken)

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

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

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

SearchListingsResponseEnumerator(SearchListingsRequest, RetryConfiguration, CancellationToken)

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

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

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