Show / Hide Table of Contents

Class FunctionsManagementPaginators

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

Constructors

FunctionsManagementPaginators(FunctionsManagementClient)

Declaration
public FunctionsManagementPaginators(FunctionsManagementClient client)
Parameters
Type Name Description
FunctionsManagementClient client

Methods

ListApplicationsRecordEnumerator(ListApplicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListApplicationsResponseEnumerator(ListApplicationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFunctionsRecordEnumerator(ListFunctionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFunctionsResponseEnumerator(ListFunctionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPbfListingVersionsRecordEnumerator(ListPbfListingVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPbfListingVersionsResponseEnumerator(ListPbfListingVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPbfListingsRecordEnumerator(ListPbfListingsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPbfListingsResponseEnumerator(ListPbfListingsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTriggersRecordEnumerator(ListTriggersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTriggersResponseEnumerator(ListTriggersRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top