Class DatabaseToolsRuntimePaginators

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

Constructors

DatabaseToolsRuntimePaginators(DatabaseToolsRuntimeClient)

Declaration
public DatabaseToolsRuntimePaginators(DatabaseToolsRuntimeClient client)
Parameters
Type Name Description
DatabaseToolsRuntimeClient client

Methods

ListCredentialExecuteGranteesRecordEnumerator(ListCredentialExecuteGranteesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCredentialExecuteGranteesResponseEnumerator(ListCredentialExecuteGranteesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCredentialPublicSynonymsRecordEnumerator(ListCredentialPublicSynonymsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCredentialPublicSynonymsResponseEnumerator(ListCredentialPublicSynonymsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCredentialsRecordEnumerator(ListCredentialsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListCredentialsResponseEnumerator(ListCredentialsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsRecordEnumerator(ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsResponseEnumerator(ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsRecordEnumerator(ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsResponseEnumerator(ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseToolsDatabaseApiGatewayConfigPoolsRecordEnumerator(ListDatabaseToolsDatabaseApiGatewayConfigPoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDatabaseToolsDatabaseApiGatewayConfigPoolsResponseEnumerator(ListDatabaseToolsDatabaseApiGatewayConfigPoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListUserCredentialsRecordEnumerator(ListUserCredentialsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListUserCredentialsResponseEnumerator(ListUserCredentialsRequest, RetryConfiguration, CancellationToken)

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

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

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