Class OrganizationPaginators
Collection of helper methods that can be used to provide an enumerator interface to any list operations of Organization 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.
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.
Inherited Members
Namespace: Oci.TenantmanagercontrolplaneService
Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll
Syntax
public class OrganizationPaginators
Constructors
OrganizationPaginators(OrganizationClient)
Declaration
public OrganizationPaginators(OrganizationClient client)
Parameters
Type | Name | Description |
---|---|---|
OrganizationClient | client |
Methods
ListOrganizationTenanciesRecordEnumerator(ListOrganizationTenanciesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the OrganizationTenancySummary objects contained in responses from the ListOrganizationTenancies operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<OrganizationTenancySummary> ListOrganizationTenanciesRecordEnumerator(ListOrganizationTenanciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListOrganizationTenanciesRequest | 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<OrganizationTenancySummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListOrganizationTenanciesResponseEnumerator(ListOrganizationTenanciesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListOrganizationTenancies operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListOrganizationTenanciesResponse> ListOrganizationTenanciesResponseEnumerator(ListOrganizationTenanciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListOrganizationTenanciesRequest | 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<ListOrganizationTenanciesResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListOrganizationsRecordEnumerator(ListOrganizationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the OrganizationSummary objects contained in responses from the ListOrganizations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<OrganizationSummary> ListOrganizationsRecordEnumerator(ListOrganizationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListOrganizationsRequest | 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<OrganizationSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListOrganizationsResponseEnumerator(ListOrganizationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListOrganizations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListOrganizationsResponse> ListOrganizationsResponseEnumerator(ListOrganizationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListOrganizationsRequest | 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<ListOrganizationsResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |