Class PostgresqlPaginators
Collection of helper methods that can be used to provide an enumerator interface to any list operations of Postgresql 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.PsqlService
Assembly: OCI.DotNetSDK.Psql.dll
Syntax
public class PostgresqlPaginators
Constructors
PostgresqlPaginators(PostgresqlClient)
Declaration
public PostgresqlPaginators(PostgresqlClient client)
Parameters
Type | Name | Description |
---|---|---|
PostgresqlClient | client |
Methods
ListBackupsRecordEnumerator(ListBackupsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the BackupSummary objects contained in responses from the ListBackups operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<BackupSummary> ListBackupsRecordEnumerator(ListBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListBackupsRequest | 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<BackupSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListBackupsResponseEnumerator(ListBackupsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListBackups operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListBackupsResponse> ListBackupsResponseEnumerator(ListBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListBackupsRequest | 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<ListBackupsResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListConfigurationsRecordEnumerator(ListConfigurationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the ConfigurationSummary objects contained in responses from the ListConfigurations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ConfigurationSummary> ListConfigurationsRecordEnumerator(ListConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListConfigurationsRequest | 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<ConfigurationSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListConfigurationsResponseEnumerator(ListConfigurationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListConfigurations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListConfigurationsResponse> ListConfigurationsResponseEnumerator(ListConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListConfigurationsRequest | 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<ListConfigurationsResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListDbSystemsRecordEnumerator(ListDbSystemsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the DbSystemSummary objects contained in responses from the ListDbSystems operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<DbSystemSummary> ListDbSystemsRecordEnumerator(ListDbSystemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListDbSystemsRequest | 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<DbSystemSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListDbSystemsResponseEnumerator(ListDbSystemsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListDbSystems operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListDbSystemsResponse> ListDbSystemsResponseEnumerator(ListDbSystemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListDbSystemsRequest | 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<ListDbSystemsResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListDefaultConfigurationsRecordEnumerator(ListDefaultConfigurationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the DefaultConfigurationSummary objects contained in responses from the ListDefaultConfigurations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<DefaultConfigurationSummary> ListDefaultConfigurationsRecordEnumerator(ListDefaultConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListDefaultConfigurationsRequest | 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<DefaultConfigurationSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListDefaultConfigurationsResponseEnumerator(ListDefaultConfigurationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListDefaultConfigurations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListDefaultConfigurationsResponse> ListDefaultConfigurationsResponseEnumerator(ListDefaultConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListDefaultConfigurationsRequest | 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<ListDefaultConfigurationsResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListShapesRecordEnumerator(ListShapesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the ShapeSummary objects contained in responses from the ListShapes operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ShapeSummary> ListShapesRecordEnumerator(ListShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListShapesRequest | 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<ShapeSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListShapesResponseEnumerator(ListShapesRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListShapes operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListShapesResponse> ListShapesResponseEnumerator(ListShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListShapesRequest | 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<ListShapesResponse> | 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 |