Class FileStoragePaginators

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

Constructors

FileStoragePaginators(FileStorageClient)

Declaration
public FileStoragePaginators(FileStorageClient client)
Parameters
Type Name Description
FileStorageClient client

Methods

ListExportSetsRecordEnumerator(ListExportSetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListExportSetsResponseEnumerator(ListExportSetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListExportsRecordEnumerator(ListExportsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListExportsResponseEnumerator(ListExportsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFileSystemsRecordEnumerator(ListFileSystemsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFileSystemsResponseEnumerator(ListFileSystemsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFilesystemSnapshotPoliciesRecordEnumerator(ListFilesystemSnapshotPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFilesystemSnapshotPoliciesResponseEnumerator(ListFilesystemSnapshotPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMountTargetsRecordEnumerator(ListMountTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMountTargetsResponseEnumerator(ListMountTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOutboundConnectorsRecordEnumerator(ListOutboundConnectorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOutboundConnectorsResponseEnumerator(ListOutboundConnectorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationTargetsRecordEnumerator(ListReplicationTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationTargetsResponseEnumerator(ListReplicationTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationsRecordEnumerator(ListReplicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListReplicationsResponseEnumerator(ListReplicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSnapshotsRecordEnumerator(ListSnapshotsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSnapshotsResponseEnumerator(ListSnapshotsRequest, RetryConfiguration, CancellationToken)

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

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

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