Show / Hide Table of Contents

Class MarketplaceAdministratorPaginators

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

Constructors

MarketplaceAdministratorPaginators(MarketplaceAdministratorClient)

Declaration
public MarketplaceAdministratorPaginators(MarketplaceAdministratorClient client)
Parameters
Type Name Description
MarketplaceAdministratorClient client

Methods

ListAdminArtifactsRecordEnumerator(ListAdminArtifactsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminArtifactsResponseEnumerator(ListAdminArtifactsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminListingRevisionAttachmentsRecordEnumerator(ListAdminListingRevisionAttachmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminListingRevisionAttachmentsResponseEnumerator(ListAdminListingRevisionAttachmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminListingRevisionPackagesRecordEnumerator(ListAdminListingRevisionPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminListingRevisionPackagesResponseEnumerator(ListAdminListingRevisionPackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminListingRevisionsRecordEnumerator(ListAdminListingRevisionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminListingRevisionsResponseEnumerator(ListAdminListingRevisionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminPublisherSkusRecordEnumerator(ListAdminPublisherSkusRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminPublisherSkusResponseEnumerator(ListAdminPublisherSkusRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminTermVersionsRecordEnumerator(ListAdminTermVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminTermVersionsResponseEnumerator(ListAdminTermVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminTermsRecordEnumerator(ListAdminTermsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminTermsResponseEnumerator(ListAdminTermsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminWorkRequestsRecordEnumerator(ListAdminWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAdminWorkRequestsResponseEnumerator(ListAdminWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top