Class ApiGatewayPaginators
Collection of helper methods that can be used to provide an enumerator interface to any list operations of ApiGateway 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.
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.
Inherited Members
Namespace: Oci.ApigatewayService
Assembly: OCI.DotNetSDK.Apigateway.dll
Syntax
public class ApiGatewayPaginators
Constructors
ApiGatewayPaginators(ApiGatewayClient)
Declaration
public ApiGatewayPaginators(ApiGatewayClient client)
Parameters
Type | Name | Description |
---|---|---|
ApiGatewayClient | client |
Methods
ListApisRecordEnumerator(ListApisRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the ApiSummary objects contained in responses from the ListApis operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ApiSummary> ListApisRecordEnumerator(ListApisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListApisRequest | 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<ApiSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListApisResponseEnumerator(ListApisRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListApis operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListApisResponse> ListApisResponseEnumerator(ListApisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListApisRequest | 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<ListApisResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListCertificatesRecordEnumerator(ListCertificatesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the CertificateSummary objects contained in responses from the ListCertificates operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<CertificateSummary> ListCertificatesRecordEnumerator(ListCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListCertificatesRequest | 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<CertificateSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListCertificatesResponseEnumerator(ListCertificatesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListCertificates operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListCertificatesResponse> ListCertificatesResponseEnumerator(ListCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListCertificatesRequest | 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<ListCertificatesResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListSdkLanguageTypesRecordEnumerator(ListSdkLanguageTypesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the SdkLanguageTypeSummary objects contained in responses from the ListSdkLanguageTypes operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<SdkLanguageTypeSummary> ListSdkLanguageTypesRecordEnumerator(ListSdkLanguageTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListSdkLanguageTypesRequest | 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<SdkLanguageTypeSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListSdkLanguageTypesResponseEnumerator(ListSdkLanguageTypesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListSdkLanguageTypes operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListSdkLanguageTypesResponse> ListSdkLanguageTypesResponseEnumerator(ListSdkLanguageTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListSdkLanguageTypesRequest | 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<ListSdkLanguageTypesResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListSdksRecordEnumerator(ListSdksRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the SdkSummary objects contained in responses from the ListSdks operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<SdkSummary> ListSdksRecordEnumerator(ListSdksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListSdksRequest | 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<SdkSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListSdksResponseEnumerator(ListSdksRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListSdks operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListSdksResponse> ListSdksResponseEnumerator(ListSdksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListSdksRequest | 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<ListSdksResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |