Class UsageapiPaginators

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

UsageapiPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.UsageapiService

Assembly: OCI.DotNetSDK.Usageapi.dll

Syntax

public class UsageapiPaginators

Constructors

UsageapiPaginators(UsageapiClient)

Declaration

public UsageapiPaginators(UsageapiClient client)

Parameters

Type	Name	Description
UsageapiClient	client

Methods

ListCustomTablesRecordEnumerator(ListCustomTablesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<CustomTableSummary> ListCustomTablesRecordEnumerator(ListCustomTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListCustomTablesResponseEnumerator(ListCustomTablesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListCustomTablesResponse> ListCustomTablesResponseEnumerator(ListCustomTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListEmailRecipientsGroupsRecordEnumerator(ListEmailRecipientsGroupsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<EmailRecipientsGroupSummary> ListEmailRecipientsGroupsRecordEnumerator(ListEmailRecipientsGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListEmailRecipientsGroupsResponseEnumerator(ListEmailRecipientsGroupsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListEmailRecipientsGroupsResponse> ListEmailRecipientsGroupsResponseEnumerator(ListEmailRecipientsGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListQueriesRecordEnumerator(ListQueriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<QuerySummary> ListQueriesRecordEnumerator(ListQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListQueriesResponseEnumerator(ListQueriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListQueriesResponse> ListQueriesResponseEnumerator(ListQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListScheduledRunsRecordEnumerator(ListScheduledRunsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ScheduledRunSummary> ListScheduledRunsRecordEnumerator(ListScheduledRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListScheduledRunsResponseEnumerator(ListScheduledRunsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListScheduledRunsResponse> ListScheduledRunsResponseEnumerator(ListScheduledRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSchedulesRecordEnumerator(ListSchedulesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ScheduleSummary> ListSchedulesRecordEnumerator(ListSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSchedulesResponseEnumerator(ListSchedulesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSchedulesResponse> ListSchedulesResponseEnumerator(ListSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListUsageCarbonEmissionsQueriesRecordEnumerator(ListUsageCarbonEmissionsQueriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<UsageCarbonEmissionsQuerySummary> ListUsageCarbonEmissionsQueriesRecordEnumerator(ListUsageCarbonEmissionsQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListUsageCarbonEmissionsQueriesResponseEnumerator(ListUsageCarbonEmissionsQueriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListUsageCarbonEmissionsQueriesResponse> ListUsageCarbonEmissionsQueriesResponseEnumerator(ListUsageCarbonEmissionsQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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