Class DiscoveryPaginators

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

DiscoveryPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CloudbridgeService

Assembly: OCI.DotNetSDK.Cloudbridge.dll

Syntax

public class DiscoveryPaginators

Constructors

DiscoveryPaginators(DiscoveryClient)

Declaration

public DiscoveryPaginators(DiscoveryClient client)

Parameters

Type	Name	Description
DiscoveryClient	client

Methods

ListAssetSourceConnectionsRecordEnumerator(ListAssetSourceConnectionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<AssetSourceConnection> ListAssetSourceConnectionsRecordEnumerator(ListAssetSourceConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAssetSourceConnectionsResponseEnumerator(ListAssetSourceConnectionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListAssetSourceConnectionsResponse> ListAssetSourceConnectionsResponseEnumerator(ListAssetSourceConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAssetSourcesRecordEnumerator(ListAssetSourcesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<AssetSourceSummary> ListAssetSourcesRecordEnumerator(ListAssetSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListAssetSourcesResponseEnumerator(ListAssetSourcesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListAssetSourcesResponse> ListAssetSourcesResponseEnumerator(ListAssetSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDiscoverySchedulesRecordEnumerator(ListDiscoverySchedulesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<DiscoveryScheduleSummary> ListDiscoverySchedulesRecordEnumerator(ListDiscoverySchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDiscoverySchedulesResponseEnumerator(ListDiscoverySchedulesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListDiscoverySchedulesResponse> ListDiscoverySchedulesResponseEnumerator(ListDiscoverySchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSupportedCloudRegionsRecordEnumerator(ListSupportedCloudRegionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SupportedCloudRegionSummary> ListSupportedCloudRegionsRecordEnumerator(ListSupportedCloudRegionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSupportedCloudRegionsResponseEnumerator(ListSupportedCloudRegionsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSupportedCloudRegionsResponse> ListSupportedCloudRegionsResponseEnumerator(ListSupportedCloudRegionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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