Class SoftwareSourcePaginators

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

Constructors

SoftwareSourcePaginators(SoftwareSourceClient)

Declaration
public SoftwareSourcePaginators(SoftwareSourceClient client)
Parameters
Type Name Description
SoftwareSourceClient client

Methods

ListAllSoftwarePackagesRecordEnumerator(ListAllSoftwarePackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAllSoftwarePackagesResponseEnumerator(ListAllSoftwarePackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListEntitlementsRecordEnumerator(ListEntitlementsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListEntitlementsResponseEnumerator(ListEntitlementsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListErrataRecordEnumerator(ListErrataRequest, RetryConfiguration, CancellationToken)

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

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

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

ListErrataResponseEnumerator(ListErrataRequest, RetryConfiguration, CancellationToken)

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

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

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

ListModuleStreamProfilesRecordEnumerator(ListModuleStreamProfilesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListModuleStreamProfilesResponseEnumerator(ListModuleStreamProfilesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListModuleStreamsRecordEnumerator(ListModuleStreamsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListModuleStreamsResponseEnumerator(ListModuleStreamsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPackageGroupsRecordEnumerator(ListPackageGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPackageGroupsResponseEnumerator(ListPackageGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSoftwarePackageSoftwareSourcesRecordEnumerator(ListSoftwarePackageSoftwareSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSoftwarePackageSoftwareSourcesResponseEnumerator(ListSoftwarePackageSoftwareSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSoftwarePackagesRecordEnumerator(ListSoftwarePackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSoftwarePackagesResponseEnumerator(ListSoftwarePackagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSoftwareSourcesRecordEnumerator(ListSoftwareSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSoftwareSourcesResponseEnumerator(ListSoftwareSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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