Class ManagementPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of Management 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
ManagementPaginators
Inherited Members
Namespace: Oci.OdaService
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class ManagementPaginators

Constructors

ManagementPaginators(ManagementClient)

Declaration
public ManagementPaginators(ManagementClient client)
Parameters
Type Name Description
ManagementClient client

Methods

ListAuthenticationProvidersRecordEnumerator(ListAuthenticationProvidersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAuthenticationProvidersResponseEnumerator(ListAuthenticationProvidersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListChannelsRecordEnumerator(ListChannelsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListChannelsResponseEnumerator(ListChannelsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalAssistantParametersRecordEnumerator(ListDigitalAssistantParametersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalAssistantParametersResponseEnumerator(ListDigitalAssistantParametersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalAssistantsRecordEnumerator(ListDigitalAssistantsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDigitalAssistantsResponseEnumerator(ListDigitalAssistantsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOdaPrivateEndpointAttachmentsRecordEnumerator(ListOdaPrivateEndpointAttachmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOdaPrivateEndpointAttachmentsResponseEnumerator(ListOdaPrivateEndpointAttachmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOdaPrivateEndpointScanProxiesRecordEnumerator(ListOdaPrivateEndpointScanProxiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOdaPrivateEndpointScanProxiesResponseEnumerator(ListOdaPrivateEndpointScanProxiesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOdaPrivateEndpointsRecordEnumerator(ListOdaPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListOdaPrivateEndpointsResponseEnumerator(ListOdaPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSkillParametersRecordEnumerator(ListSkillParametersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSkillParametersResponseEnumerator(ListSkillParametersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSkillsRecordEnumerator(ListSkillsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSkillsResponseEnumerator(ListSkillsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTranslatorsRecordEnumerator(ListTranslatorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTranslatorsResponseEnumerator(ListTranslatorsRequest, RetryConfiguration, CancellationToken)

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

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

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