Class DesktopServicePaginators

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

DesktopServicePaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DesktopsService

Assembly: OCI.DotNetSDK.Desktops.dll

Syntax

public class DesktopServicePaginators

Constructors

DesktopServicePaginators(DesktopServiceClient)

Declaration

public DesktopServicePaginators(DesktopServiceClient client)

Parameters

Type	Name	Description
DesktopServiceClient	client

Methods

ListDesktopPoolDesktopsRecordEnumerator(ListDesktopPoolDesktopsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<DesktopPoolDesktopSummary> ListDesktopPoolDesktopsRecordEnumerator(ListDesktopPoolDesktopsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDesktopPoolDesktopsResponseEnumerator(ListDesktopPoolDesktopsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListDesktopPoolDesktopsResponse> ListDesktopPoolDesktopsResponseEnumerator(ListDesktopPoolDesktopsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDesktopPoolVolumesRecordEnumerator(ListDesktopPoolVolumesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<DesktopPoolVolumeSummary> ListDesktopPoolVolumesRecordEnumerator(ListDesktopPoolVolumesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDesktopPoolVolumesResponseEnumerator(ListDesktopPoolVolumesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListDesktopPoolVolumesResponse> ListDesktopPoolVolumesResponseEnumerator(ListDesktopPoolVolumesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDesktopPoolsRecordEnumerator(ListDesktopPoolsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<DesktopPoolSummary> ListDesktopPoolsRecordEnumerator(ListDesktopPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDesktopPoolsResponseEnumerator(ListDesktopPoolsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListDesktopPoolsResponse> ListDesktopPoolsResponseEnumerator(ListDesktopPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDesktopsRecordEnumerator(ListDesktopsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<DesktopSummary> ListDesktopsRecordEnumerator(ListDesktopsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDesktopsResponseEnumerator(ListDesktopsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListDesktopsResponse> ListDesktopsResponseEnumerator(ListDesktopsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListDesktopsRequest	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<ListDesktopsResponse>	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