Class ContainerEnginePaginators

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

Constructors

ContainerEnginePaginators(ContainerEngineClient)

Declaration
public ContainerEnginePaginators(ContainerEngineClient client)
Parameters
Type Name Description
ContainerEngineClient client

Methods

ListAddonOptionsRecordEnumerator(ListAddonOptionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAddonOptionsResponseEnumerator(ListAddonOptionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAddonsRecordEnumerator(ListAddonsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAddonsResponseEnumerator(ListAddonsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListClustersRecordEnumerator(ListClustersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListClustersResponseEnumerator(ListClustersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListNodePoolsRecordEnumerator(ListNodePoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListNodePoolsResponseEnumerator(ListNodePoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPodShapesRecordEnumerator(ListPodShapesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPodShapesResponseEnumerator(ListPodShapesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualNodePoolsRecordEnumerator(ListVirtualNodePoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualNodePoolsResponseEnumerator(ListVirtualNodePoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualNodesRecordEnumerator(ListVirtualNodesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualNodesResponseEnumerator(ListVirtualNodesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkloadMappingsRecordEnumerator(ListWorkloadMappingsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkloadMappingsResponseEnumerator(ListWorkloadMappingsRequest, RetryConfiguration, CancellationToken)

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

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

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