Class ObjectStoragePaginators

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

Constructors

ObjectStoragePaginators(ObjectStorageClient)

Declaration
public ObjectStoragePaginators(ObjectStorageClient client)
Parameters
Type Name Description
ObjectStorageClient client

Methods

ListBucketsRecordEnumerator(ListBucketsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBucketsResponseEnumerator(ListBucketsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMultipartUploadPartsRecordEnumerator(ListMultipartUploadPartsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMultipartUploadPartsResponseEnumerator(ListMultipartUploadPartsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMultipartUploadsRecordEnumerator(ListMultipartUploadsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMultipartUploadsResponseEnumerator(ListMultipartUploadsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListObjectVersionsRecordEnumerator(ListObjectVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListObjectVersionsResponseEnumerator(ListObjectVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListObjectsRecordEnumerator(ListObjectsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListObjectsResponseEnumerator(ListObjectsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPreauthenticatedRequestsRecordEnumerator(ListPreauthenticatedRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPreauthenticatedRequestsResponseEnumerator(ListPreauthenticatedRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateEndpointsRecordEnumerator(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateEndpointsResponseEnumerator(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationPoliciesRecordEnumerator(ListReplicationPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationPoliciesResponseEnumerator(ListReplicationPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationSourcesRecordEnumerator(ListReplicationSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationSourcesResponseEnumerator(ListReplicationSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListRetentionRulesRecordEnumerator(ListRetentionRulesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListRetentionRulesResponseEnumerator(ListRetentionRulesRequest, RetryConfiguration, CancellationToken)

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

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

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 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