Class IotPaginators

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

Constructors

IotPaginators(IotClient)

Declaration
public IotPaginators(IotClient client)
Parameters
Type Name Description
IotClient client

Methods

ListDigitalTwinAdaptersRecordEnumerator(ListDigitalTwinAdaptersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalTwinAdaptersResponseEnumerator(ListDigitalTwinAdaptersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalTwinInstancesRecordEnumerator(ListDigitalTwinInstancesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalTwinInstancesResponseEnumerator(ListDigitalTwinInstancesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalTwinModelsRecordEnumerator(ListDigitalTwinModelsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalTwinModelsResponseEnumerator(ListDigitalTwinModelsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalTwinRelationshipsRecordEnumerator(ListDigitalTwinRelationshipsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalTwinRelationshipsResponseEnumerator(ListDigitalTwinRelationshipsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIotDomainGroupsRecordEnumerator(ListIotDomainGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIotDomainGroupsResponseEnumerator(ListIotDomainGroupsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIotDomainsRecordEnumerator(ListIotDomainsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIotDomainsResponseEnumerator(ListIotDomainsRequest, RetryConfiguration, CancellationToken)

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

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

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