Class SqlTuningPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of SqlTuning 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

SqlTuningPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasemanagementService

Assembly: OCI.DotNetSDK.Databasemanagement.dll

Syntax

public class SqlTuningPaginators

Constructors

SqlTuningPaginators(SqlTuningClient)

Declaration

public SqlTuningPaginators(SqlTuningClient client)

Parameters

Type	Name	Description
SqlTuningClient	client

Methods

ListSqlTuningAdvisorTaskFindingsRecordEnumerator(ListSqlTuningAdvisorTaskFindingsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SqlTuningAdvisorTaskFindingSummary> ListSqlTuningAdvisorTaskFindingsRecordEnumerator(ListSqlTuningAdvisorTaskFindingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningAdvisorTaskFindingsRequest	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<SqlTuningAdvisorTaskFindingSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlTuningAdvisorTaskFindingsResponseEnumerator(ListSqlTuningAdvisorTaskFindingsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSqlTuningAdvisorTaskFindingsResponse> ListSqlTuningAdvisorTaskFindingsResponseEnumerator(ListSqlTuningAdvisorTaskFindingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningAdvisorTaskFindingsRequest	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<ListSqlTuningAdvisorTaskFindingsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlTuningAdvisorTaskRecommendationsRecordEnumerator(ListSqlTuningAdvisorTaskRecommendationsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SqlTuningAdvisorTaskRecommendationSummary> ListSqlTuningAdvisorTaskRecommendationsRecordEnumerator(ListSqlTuningAdvisorTaskRecommendationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningAdvisorTaskRecommendationsRequest	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<SqlTuningAdvisorTaskRecommendationSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlTuningAdvisorTaskRecommendationsResponseEnumerator(ListSqlTuningAdvisorTaskRecommendationsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSqlTuningAdvisorTaskRecommendationsResponse> ListSqlTuningAdvisorTaskRecommendationsResponseEnumerator(ListSqlTuningAdvisorTaskRecommendationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningAdvisorTaskRecommendationsRequest	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<ListSqlTuningAdvisorTaskRecommendationsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlTuningAdvisorTasksRecordEnumerator(ListSqlTuningAdvisorTasksRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SqlTuningAdvisorTaskSummary> ListSqlTuningAdvisorTasksRecordEnumerator(ListSqlTuningAdvisorTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningAdvisorTasksRequest	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<SqlTuningAdvisorTaskSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlTuningAdvisorTasksResponseEnumerator(ListSqlTuningAdvisorTasksRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSqlTuningAdvisorTasksResponse> ListSqlTuningAdvisorTasksResponseEnumerator(ListSqlTuningAdvisorTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningAdvisorTasksRequest	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<ListSqlTuningAdvisorTasksResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlTuningSetsRecordEnumerator(ListSqlTuningSetsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SqlTuningSetSummary> ListSqlTuningSetsRecordEnumerator(ListSqlTuningSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningSetsRequest	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<SqlTuningSetSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListSqlTuningSetsResponseEnumerator(ListSqlTuningSetsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSqlTuningSetsResponse> ListSqlTuningSetsResponseEnumerator(ListSqlTuningSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSqlTuningSetsRequest	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<ListSqlTuningSetsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type