Class ResourceManagerPaginators

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

Constructors

ResourceManagerPaginators(ResourceManagerClient)

Declaration
public ResourceManagerPaginators(ResourceManagerClient client)
Parameters
Type Name Description
ResourceManagerClient client

Methods

GetJobLogsRecordEnumerator(GetJobLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

GetJobLogsResponseEnumerator(GetJobLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConfigurationSourceProvidersRecordEnumerator(ListConfigurationSourceProvidersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConfigurationSourceProvidersResponseEnumerator(ListConfigurationSourceProvidersRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobAssociatedResourcesRecordEnumerator(ListJobAssociatedResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobAssociatedResourcesResponseEnumerator(ListJobAssociatedResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobOutputsRecordEnumerator(ListJobOutputsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobOutputsResponseEnumerator(ListJobOutputsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobsRecordEnumerator(ListJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJobsResponseEnumerator(ListJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateEndpointsRecordEnumerator(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListPrivateEndpointsResponseEnumerator(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStackAssociatedResourcesRecordEnumerator(ListStackAssociatedResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStackAssociatedResourcesResponseEnumerator(ListStackAssociatedResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStackResourceDriftDetailsRecordEnumerator(ListStackResourceDriftDetailsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStackResourceDriftDetailsResponseEnumerator(ListStackResourceDriftDetailsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStacksRecordEnumerator(ListStacksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStacksResponseEnumerator(ListStacksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTemplatesRecordEnumerator(ListTemplatesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListTemplatesResponseEnumerator(ListTemplatesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

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

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

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