Class BlockstoragePaginators

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

Constructors

BlockstoragePaginators(BlockstorageClient)

Declaration
public BlockstoragePaginators(BlockstorageClient client)
Parameters
Type Name Description
BlockstorageClient client

Methods

GetVolumeBackupPolicyAssetAssignmentRecordEnumerator(GetVolumeBackupPolicyAssetAssignmentRequest, RetryConfiguration, CancellationToken)

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

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

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

GetVolumeBackupPolicyAssetAssignmentResponseEnumerator(GetVolumeBackupPolicyAssetAssignmentRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBlockVolumeReplicasRecordEnumerator(ListBlockVolumeReplicasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBlockVolumeReplicasResponseEnumerator(ListBlockVolumeReplicasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBootVolumeBackupsRecordEnumerator(ListBootVolumeBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBootVolumeBackupsResponseEnumerator(ListBootVolumeBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBootVolumeReplicasRecordEnumerator(ListBootVolumeReplicasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBootVolumeReplicasResponseEnumerator(ListBootVolumeReplicasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBootVolumesRecordEnumerator(ListBootVolumesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBootVolumesResponseEnumerator(ListBootVolumesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeBackupPoliciesRecordEnumerator(ListVolumeBackupPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeBackupPoliciesResponseEnumerator(ListVolumeBackupPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeBackupsRecordEnumerator(ListVolumeBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeBackupsResponseEnumerator(ListVolumeBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeGroupBackupsRecordEnumerator(ListVolumeGroupBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeGroupBackupsResponseEnumerator(ListVolumeGroupBackupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeGroupReplicasRecordEnumerator(ListVolumeGroupReplicasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeGroupReplicasResponseEnumerator(ListVolumeGroupReplicasRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeGroupsRecordEnumerator(ListVolumeGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumeGroupsResponseEnumerator(ListVolumeGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumesRecordEnumerator(ListVolumesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVolumesResponseEnumerator(ListVolumesRequest, RetryConfiguration, CancellationToken)

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

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

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