Show / Hide Table of Contents

Class FleetAppsManagementAdminPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of FleetAppsManagementAdmin 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
FleetAppsManagementAdminPaginators
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.FleetappsmanagementService
Assembly: OCI.DotNetSDK.Fleetappsmanagement.dll
Syntax
public class FleetAppsManagementAdminPaginators

Constructors

FleetAppsManagementAdminPaginators(FleetAppsManagementAdminClient)

Declaration
public FleetAppsManagementAdminPaginators(FleetAppsManagementAdminClient client)
Parameters
Type Name Description
FleetAppsManagementAdminClient client

Methods

ListCompliancePoliciesRecordEnumerator(ListCompliancePoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCompliancePoliciesResponseEnumerator(ListCompliancePoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCompliancePolicyRulesRecordEnumerator(ListCompliancePolicyRulesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCompliancePolicyRulesResponseEnumerator(ListCompliancePolicyRulesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOnboardingPoliciesRecordEnumerator(ListOnboardingPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOnboardingPoliciesResponseEnumerator(ListOnboardingPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOnboardingsRecordEnumerator(ListOnboardingsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOnboardingsResponseEnumerator(ListOnboardingsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPlatformConfigurationsRecordEnumerator(ListPlatformConfigurationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPlatformConfigurationsResponseEnumerator(ListPlatformConfigurationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPropertiesRecordEnumerator(ListPropertiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPropertiesResponseEnumerator(ListPropertiesRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top