Class LicenseManagerPaginators

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

LicenseManagerPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LicensemanagerService

Assembly: OCI.DotNetSDK.Licensemanager.dll

Syntax

public class LicenseManagerPaginators

Constructors

LicenseManagerPaginators(LicenseManagerClient)

Declaration

public LicenseManagerPaginators(LicenseManagerClient client)

Parameters

Type	Name	Description
LicenseManagerClient	client

Methods

ListLicenseRecordsRecordEnumerator(ListLicenseRecordsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<LicenseRecordSummary> ListLicenseRecordsRecordEnumerator(ListLicenseRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListLicenseRecordsResponseEnumerator(ListLicenseRecordsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListLicenseRecordsResponse> ListLicenseRecordsResponseEnumerator(ListLicenseRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListProductLicenseConsumersRecordEnumerator(ListProductLicenseConsumersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ProductLicenseConsumerSummary> ListProductLicenseConsumersRecordEnumerator(ListProductLicenseConsumersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListProductLicenseConsumersResponseEnumerator(ListProductLicenseConsumersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListProductLicenseConsumersResponse> ListProductLicenseConsumersResponseEnumerator(ListProductLicenseConsumersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListProductLicensesRecordEnumerator(ListProductLicensesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ProductLicenseSummary> ListProductLicensesRecordEnumerator(ListProductLicensesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListProductLicensesResponseEnumerator(ListProductLicensesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListProductLicensesResponse> ListProductLicensesResponseEnumerator(ListProductLicensesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListTopUtilizedProductLicensesRecordEnumerator(ListTopUtilizedProductLicensesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<TopUtilizedProductLicenseSummary> ListTopUtilizedProductLicensesRecordEnumerator(ListTopUtilizedProductLicensesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListTopUtilizedProductLicensesResponseEnumerator(ListTopUtilizedProductLicensesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListTopUtilizedProductLicensesResponse> ListTopUtilizedProductLicensesResponseEnumerator(ListTopUtilizedProductLicensesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListTopUtilizedResourcesRecordEnumerator(ListTopUtilizedResourcesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<TopUtilizedResourceSummary> ListTopUtilizedResourcesRecordEnumerator(ListTopUtilizedResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListTopUtilizedResourcesResponseEnumerator(ListTopUtilizedResourcesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListTopUtilizedResourcesResponse> ListTopUtilizedResourcesResponseEnumerator(ListTopUtilizedResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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