Show / Hide Table of Contents

Class CertificatesManagementPaginators

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

Constructors

CertificatesManagementPaginators(CertificatesManagementClient)

Declaration
public CertificatesManagementPaginators(CertificatesManagementClient client)
Parameters
Type Name Description
CertificatesManagementClient client

Methods

ListAssociationsRecordEnumerator(ListAssociationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAssociationsResponseEnumerator(ListAssociationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCaBundlesRecordEnumerator(ListCaBundlesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCaBundlesResponseEnumerator(ListCaBundlesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCertificateAuthoritiesRecordEnumerator(ListCertificateAuthoritiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCertificateAuthoritiesResponseEnumerator(ListCertificateAuthoritiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCertificateAuthorityVersionsRecordEnumerator(ListCertificateAuthorityVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCertificateAuthorityVersionsResponseEnumerator(ListCertificateAuthorityVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCertificateVersionsRecordEnumerator(ListCertificateVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCertificateVersionsResponseEnumerator(ListCertificateVersionsRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top