Class CapacityManagementPaginators

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

Constructors

CapacityManagementPaginators(CapacityManagementClient)

Declaration
public CapacityManagementPaginators(CapacityManagementClient client)
Parameters
Type Name Description
CapacityManagementClient client

Methods

ListInternalNamespaceOccOverviewsRecordEnumerator(ListInternalNamespaceOccOverviewsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInternalNamespaceOccOverviewsResponseEnumerator(ListInternalNamespaceOccOverviewsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInternalOccHandoverResourceBlockDetailsRecordEnumerator(ListInternalOccHandoverResourceBlockDetailsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInternalOccHandoverResourceBlockDetailsResponseEnumerator(ListInternalOccHandoverResourceBlockDetailsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInternalOccHandoverResourceBlocksRecordEnumerator(ListInternalOccHandoverResourceBlocksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInternalOccHandoverResourceBlocksResponseEnumerator(ListInternalOccHandoverResourceBlocksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccAvailabilitiesRecordEnumerator(ListOccAvailabilitiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccAvailabilitiesResponseEnumerator(ListOccAvailabilitiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccAvailabilityCatalogsInternalRecordEnumerator(ListOccAvailabilityCatalogsInternalRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccAvailabilityCatalogsInternalResponseEnumerator(ListOccAvailabilityCatalogsInternalRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccAvailabilityCatalogsRecordEnumerator(ListOccAvailabilityCatalogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccAvailabilityCatalogsResponseEnumerator(ListOccAvailabilityCatalogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccCapacityRequestsInternalRecordEnumerator(ListOccCapacityRequestsInternalRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccCapacityRequestsInternalResponseEnumerator(ListOccCapacityRequestsInternalRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccCapacityRequestsRecordEnumerator(ListOccCapacityRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccCapacityRequestsResponseEnumerator(ListOccCapacityRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccCustomerGroupsRecordEnumerator(ListOccCustomerGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccCustomerGroupsResponseEnumerator(ListOccCustomerGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccHandoverResourceBlockDetailsRecordEnumerator(ListOccHandoverResourceBlockDetailsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccHandoverResourceBlockDetailsResponseEnumerator(ListOccHandoverResourceBlockDetailsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccHandoverResourceBlocksRecordEnumerator(ListOccHandoverResourceBlocksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccHandoverResourceBlocksResponseEnumerator(ListOccHandoverResourceBlocksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccOverviewsRecordEnumerator(ListOccOverviewsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccOverviewsResponseEnumerator(ListOccOverviewsRequest, RetryConfiguration, CancellationToken)

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

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

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