Class RedisClusterPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of RedisCluster 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

RedisClusterPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.RedisService

Assembly: OCI.DotNetSDK.Redis.dll

Syntax

public class RedisClusterPaginators

Constructors

RedisClusterPaginators(RedisClusterClient)

Declaration

public RedisClusterPaginators(RedisClusterClient client)

Parameters

Type	Name	Description
RedisClusterClient	client

Methods

ListAttachedOciCacheUsersRecordEnumerator(ListAttachedOciCacheUsersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<AttachedOciCacheUser> ListAttachedOciCacheUsersRecordEnumerator(ListAttachedOciCacheUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAttachedOciCacheUsersRequest	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<AttachedOciCacheUser>	The enumerator, which supports a simple iteration over a collection of a specified type

ListAttachedOciCacheUsersResponseEnumerator(ListAttachedOciCacheUsersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListAttachedOciCacheUsersResponse> ListAttachedOciCacheUsersResponseEnumerator(ListAttachedOciCacheUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAttachedOciCacheUsersRequest	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<ListAttachedOciCacheUsersResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRedisClusterNodesRecordEnumerator(ListRedisClusterNodesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<NodeSummary> ListRedisClusterNodesRecordEnumerator(ListRedisClusterNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRedisClusterNodesRequest	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<NodeSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRedisClusterNodesResponseEnumerator(ListRedisClusterNodesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListRedisClusterNodesResponse> ListRedisClusterNodesResponseEnumerator(ListRedisClusterNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRedisClusterNodesRequest	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<ListRedisClusterNodesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRedisClustersRecordEnumerator(ListRedisClustersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<RedisClusterSummary> ListRedisClustersRecordEnumerator(ListRedisClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRedisClustersRequest	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<RedisClusterSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRedisClustersResponseEnumerator(ListRedisClustersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListRedisClustersResponse> ListRedisClustersResponseEnumerator(ListRedisClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRedisClustersRequest	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<ListRedisClustersResponse>	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