Class BaseinfraPaginators

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

Constructors

BaseinfraPaginators(BaseinfraClient)

Declaration
public BaseinfraPaginators(BaseinfraClient client)
Parameters
Type Name Description
BaseinfraClient client

Methods

ListInfrastructuresRecordEnumerator(ListInfrastructuresRequest, RetryConfiguration, CancellationToken)

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

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

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

ListInfrastructuresResponseEnumerator(ListInfrastructuresRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMaintenanceExecutionsRecordEnumerator(ListMaintenanceExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMaintenanceExecutionsResponseEnumerator(ListMaintenanceExecutionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMaintenanceRunsRecordEnumerator(ListMaintenanceRunsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMaintenanceRunsResponseEnumerator(ListMaintenanceRunsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVmClusterNetworksRecordEnumerator(ListVmClusterNetworksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVmClusterNetworksResponseEnumerator(ListVmClusterNetworksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVmInstancesRecordEnumerator(ListVmInstancesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVmInstancesResponseEnumerator(ListVmInstancesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

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

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 WorkRequest objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration
public IEnumerable<WorkRequest> 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<WorkRequest>

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