Class SubscriptionPaginators

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

SubscriptionPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.TenantmanagercontrolplaneService

Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll

Syntax

public class SubscriptionPaginators

Constructors

SubscriptionPaginators(SubscriptionClient)

Declaration

public SubscriptionPaginators(SubscriptionClient client)

Parameters

Type	Name	Description
SubscriptionClient	client

Methods

ListAssignedSubscriptionLineItemsRecordEnumerator(ListAssignedSubscriptionLineItemsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<AssignedSubscriptionLineItemSummary> ListAssignedSubscriptionLineItemsRecordEnumerator(ListAssignedSubscriptionLineItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAssignedSubscriptionLineItemsResponseEnumerator(ListAssignedSubscriptionLineItemsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListAssignedSubscriptionLineItemsResponse> ListAssignedSubscriptionLineItemsResponseEnumerator(ListAssignedSubscriptionLineItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAssignedSubscriptionsRecordEnumerator(ListAssignedSubscriptionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<AssignedSubscriptionSummary> ListAssignedSubscriptionsRecordEnumerator(ListAssignedSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAssignedSubscriptionsResponseEnumerator(ListAssignedSubscriptionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListAssignedSubscriptionsResponse> ListAssignedSubscriptionsResponseEnumerator(ListAssignedSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAvailableRegionsRecordEnumerator(ListAvailableRegionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<AvailableRegionSummary> ListAvailableRegionsRecordEnumerator(ListAvailableRegionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAvailableRegionsResponseEnumerator(ListAvailableRegionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListAvailableRegionsResponse> ListAvailableRegionsResponseEnumerator(ListAvailableRegionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSubscriptionLineItemsRecordEnumerator(ListSubscriptionLineItemsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SubscriptionLineItemSummary> ListSubscriptionLineItemsRecordEnumerator(ListSubscriptionLineItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSubscriptionLineItemsResponseEnumerator(ListSubscriptionLineItemsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSubscriptionLineItemsResponse> ListSubscriptionLineItemsResponseEnumerator(ListSubscriptionLineItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSubscriptionMappingsRecordEnumerator(ListSubscriptionMappingsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SubscriptionMappingSummary> ListSubscriptionMappingsRecordEnumerator(ListSubscriptionMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSubscriptionMappingsResponseEnumerator(ListSubscriptionMappingsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSubscriptionMappingsResponse> ListSubscriptionMappingsResponseEnumerator(ListSubscriptionMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSubscriptionsRecordEnumerator(ListSubscriptionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SubscriptionSummary> ListSubscriptionsRecordEnumerator(ListSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSubscriptionsResponseEnumerator(ListSubscriptionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSubscriptionsResponse> ListSubscriptionsResponseEnumerator(ListSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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