Show / Hide Table of Contents

Class FleetAppsManagementOperationsPaginators

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

Constructors

FleetAppsManagementOperationsPaginators(FleetAppsManagementOperationsClient)

Declaration
public FleetAppsManagementOperationsPaginators(FleetAppsManagementOperationsClient client)
Parameters
Type Name Description
FleetAppsManagementOperationsClient client

Methods

ListComplianceRecordsRecordEnumerator(ListComplianceRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListComplianceRecordsResponseEnumerator(ListComplianceRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListExecutionsRecordEnumerator(ListExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListExecutionsResponseEnumerator(ListExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInventoryRecordsRecordEnumerator(ListInventoryRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInventoryRecordsResponseEnumerator(ListInventoryRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPatchesRecordEnumerator(ListPatchesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPatchesResponseEnumerator(ListPatchesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListResourcesRecordEnumerator(ListResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListResourcesResponseEnumerator(ListResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListScheduledFleetsRecordEnumerator(ListScheduledFleetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListScheduledFleetsResponseEnumerator(ListScheduledFleetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSchedulerDefinitionsRecordEnumerator(ListSchedulerDefinitionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSchedulerDefinitionsResponseEnumerator(ListSchedulerDefinitionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSchedulerExecutionsRecordEnumerator(ListSchedulerExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSchedulerExecutionsResponseEnumerator(ListSchedulerExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSchedulerJobsRecordEnumerator(ListSchedulerJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSchedulerJobsResponseEnumerator(ListSchedulerJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStepsRecordEnumerator(ListStepsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStepsResponseEnumerator(ListStepsRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top