Show / Hide Table of Contents

Class DemandSignalPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of DemandSignal 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
DemandSignalPaginators
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CapacitymanagementService
Assembly: OCI.DotNetSDK.Capacitymanagement.dll
Syntax
public class DemandSignalPaginators

Constructors

DemandSignalPaginators(DemandSignalClient)

Declaration
public DemandSignalPaginators(DemandSignalClient client)
Parameters
Type Name Description
DemandSignalClient client

Methods

ListOccmDemandSignalCatalogResourcesRecordEnumerator(ListOccmDemandSignalCatalogResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccmDemandSignalCatalogResourcesResponseEnumerator(ListOccmDemandSignalCatalogResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccmDemandSignalDeliveriesRecordEnumerator(ListOccmDemandSignalDeliveriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccmDemandSignalDeliveriesResponseEnumerator(ListOccmDemandSignalDeliveriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccmDemandSignalItemsRecordEnumerator(ListOccmDemandSignalItemsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccmDemandSignalItemsResponseEnumerator(ListOccmDemandSignalItemsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccmDemandSignalsRecordEnumerator(ListOccmDemandSignalsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOccmDemandSignalsResponseEnumerator(ListOccmDemandSignalsRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top