com.oracle.bmc.databasemanagement

Class DbManagementPaginators

java.lang.Object

com.oracle.bmc.databasemanagement.DbManagementPaginators

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public class DbManagementPaginators
extends Object

Collection of helper methods that can be used to provide an Iterable interface to any list operations of DbManagement where multiple pages of data may be fetched. Two styles of iteration are supported:

• Iterating over the Response objects returned by the list operation. These are referred to as ResponseIterators, and the methods are suffixed with ResponseIterator. For example: listUsersResponseIterator
• Iterating over the resources/records being listed. These are referred to as RecordIterators, and the methods are suffixed with RecordIterator. For example: listUsersRecordIterator

These iterables 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 Iterable returned by calling a ResponseIterator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the Iterable returned by calling a RecordIterator 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.

Constructor Summary

Constructors

Constructor and Description
DbManagementPaginators(DbManagement client)

Method Summary

Modifier and Type	Method and Description
Iterable<JobExecutionSummary>	listJobExecutionsRecordIterator(ListJobExecutionsRequest request) Creates a new iterable which will iterate over the JobExecutionSummary objects contained in responses from the listJobExecutions operation.
Iterable<ListJobExecutionsResponse>	listJobExecutionsResponseIterator(ListJobExecutionsRequest request) Creates a new iterable which will iterate over the responses received from the listJobExecutions operation.
Iterable<JobRunSummary>	listJobRunsRecordIterator(ListJobRunsRequest request) Creates a new iterable which will iterate over the JobRunSummary objects contained in responses from the listJobRuns operation.
Iterable<ListJobRunsResponse>	listJobRunsResponseIterator(ListJobRunsRequest request) Creates a new iterable which will iterate over the responses received from the listJobRuns operation.
Iterable<JobSummary>	listJobsRecordIterator(ListJobsRequest request) Creates a new iterable which will iterate over the JobSummary objects contained in responses from the listJobs operation.
Iterable<ListJobsResponse>	listJobsResponseIterator(ListJobsRequest request) Creates a new iterable which will iterate over the responses received from the listJobs operation.
Iterable<ManagedDatabaseGroupSummary>	listManagedDatabaseGroupsRecordIterator(ListManagedDatabaseGroupsRequest request) Creates a new iterable which will iterate over the ManagedDatabaseGroupSummary objects contained in responses from the listManagedDatabaseGroups operation.
Iterable<ListManagedDatabaseGroupsResponse>	listManagedDatabaseGroupsResponseIterator(ListManagedDatabaseGroupsRequest request) Creates a new iterable which will iterate over the responses received from the listManagedDatabaseGroups operation.
Iterable<ManagedDatabaseSummary>	listManagedDatabasesRecordIterator(ListManagedDatabasesRequest request) Creates a new iterable which will iterate over the ManagedDatabaseSummary objects contained in responses from the listManagedDatabases operation.
Iterable<ListManagedDatabasesResponse>	listManagedDatabasesResponseIterator(ListManagedDatabasesRequest request) Creates a new iterable which will iterate over the responses received from the listManagedDatabases operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbManagementPaginators

@ConstructorProperties(value="client")
public DbManagementPaginators(DbManagement client)

Method Detail

listJobExecutionsResponseIterator

public Iterable<ListJobExecutionsResponse> listJobExecutionsResponseIterator(ListJobExecutionsRequest request)

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

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listJobExecutionsRecordIterator

public Iterable<JobExecutionSummary> listJobExecutionsRecordIterator(ListJobExecutionsRequest request)

Creates a new iterable which will iterate over the JobExecutionSummary objects contained in responses from the listJobExecutions operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the JobExecutionSummary objects contained in responses received from the service.

listJobRunsResponseIterator

public Iterable<ListJobRunsResponse> listJobRunsResponseIterator(ListJobRunsRequest request)

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

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listJobRunsRecordIterator

public Iterable<JobRunSummary> listJobRunsRecordIterator(ListJobRunsRequest request)

Creates a new iterable which will iterate over the JobRunSummary objects contained in responses from the listJobRuns operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the JobRunSummary objects contained in responses received from the service.

listJobsResponseIterator

public Iterable<ListJobsResponse> listJobsResponseIterator(ListJobsRequest request)

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

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listJobsRecordIterator

public Iterable<JobSummary> listJobsRecordIterator(ListJobsRequest request)

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

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the JobSummary objects contained in responses received from the service.

listManagedDatabaseGroupsResponseIterator

public Iterable<ListManagedDatabaseGroupsResponse> listManagedDatabaseGroupsResponseIterator(ListManagedDatabaseGroupsRequest request)

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

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listManagedDatabaseGroupsRecordIterator

public Iterable<ManagedDatabaseGroupSummary> listManagedDatabaseGroupsRecordIterator(ListManagedDatabaseGroupsRequest request)

Creates a new iterable which will iterate over the ManagedDatabaseGroupSummary objects contained in responses from the listManagedDatabaseGroups operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the ManagedDatabaseGroupSummary objects contained in responses received from the service.

listManagedDatabasesResponseIterator

public Iterable<ListManagedDatabasesResponse> listManagedDatabasesResponseIterator(ListManagedDatabasesRequest request)

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

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listManagedDatabasesRecordIterator

public Iterable<ManagedDatabaseSummary> listManagedDatabasesRecordIterator(ListManagedDatabasesRequest request)

Creates a new iterable which will iterate over the ManagedDatabaseSummary objects contained in responses from the listManagedDatabases operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the ManagedDatabaseSummary objects contained in responses received from the service.