com.oracle.bmc.dataflow

Class DataFlowPaginators

java.lang.Object

com.oracle.bmc.dataflow.DataFlowPaginators

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

Collection of helper methods that can be used to provide an Iterable interface to any list operations of DataFlow 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
DataFlowPaginators(DataFlow client)

Method Summary

Modifier and Type	Method and Description
Iterable<ApplicationSummary>	listApplicationsRecordIterator(ListApplicationsRequest request) Creates a new iterable which will iterate over the ApplicationSummary objects contained in responses from the listApplications operation.
Iterable<ListApplicationsResponse>	listApplicationsResponseIterator(ListApplicationsRequest request) Creates a new iterable which will iterate over the responses received from the listApplications operation.
Iterable<PoolSummary>	listPoolsRecordIterator(ListPoolsRequest request) Creates a new iterable which will iterate over the PoolSummary objects contained in responses from the listPools operation.
Iterable<ListPoolsResponse>	listPoolsResponseIterator(ListPoolsRequest request) Creates a new iterable which will iterate over the responses received from the listPools operation.
Iterable<PrivateEndpointSummary>	listPrivateEndpointsRecordIterator(ListPrivateEndpointsRequest request) Creates a new iterable which will iterate over the PrivateEndpointSummary objects contained in responses from the listPrivateEndpoints operation.
Iterable<ListPrivateEndpointsResponse>	listPrivateEndpointsResponseIterator(ListPrivateEndpointsRequest request) Creates a new iterable which will iterate over the responses received from the listPrivateEndpoints operation.
Iterable<RunLogSummary>	listRunLogsRecordIterator(ListRunLogsRequest request) Creates a new iterable which will iterate over the RunLogSummary objects contained in responses from the listRunLogs operation.
Iterable<ListRunLogsResponse>	listRunLogsResponseIterator(ListRunLogsRequest request) Creates a new iterable which will iterate over the responses received from the listRunLogs operation.
Iterable<RunSummary>	listRunsRecordIterator(ListRunsRequest request) Creates a new iterable which will iterate over the RunSummary objects contained in responses from the listRuns operation.
Iterable<ListRunsResponse>	listRunsResponseIterator(ListRunsRequest request) Creates a new iterable which will iterate over the responses received from the listRuns operation.
Iterable<SqlEndpointSummary>	listSqlEndpointsRecordIterator(ListSqlEndpointsRequest request) Creates a new iterable which will iterate over the SqlEndpointSummary objects contained in responses from the listSqlEndpoints operation.
Iterable<ListSqlEndpointsResponse>	listSqlEndpointsResponseIterator(ListSqlEndpointsRequest request) Creates a new iterable which will iterate over the responses received from the listSqlEndpoints operation.
Iterable<StatementSummary>	listStatementsRecordIterator(ListStatementsRequest request) Creates a new iterable which will iterate over the StatementSummary objects contained in responses from the listStatements operation.
Iterable<ListStatementsResponse>	listStatementsResponseIterator(ListStatementsRequest request) Creates a new iterable which will iterate over the responses received from the listStatements operation.
Iterable<WorkRequestError>	listWorkRequestErrorsRecordIterator(ListWorkRequestErrorsRequest request) Creates a new iterable which will iterate over the WorkRequestError objects contained in responses from the listWorkRequestErrors operation.
Iterable<ListWorkRequestErrorsResponse>	listWorkRequestErrorsResponseIterator(ListWorkRequestErrorsRequest request) Creates a new iterable which will iterate over the responses received from the listWorkRequestErrors operation.
Iterable<WorkRequestLog>	listWorkRequestLogsRecordIterator(ListWorkRequestLogsRequest request) Creates a new iterable which will iterate over the WorkRequestLog objects contained in responses from the listWorkRequestLogs operation.
Iterable<ListWorkRequestLogsResponse>	listWorkRequestLogsResponseIterator(ListWorkRequestLogsRequest request) Creates a new iterable which will iterate over the responses received from the listWorkRequestLogs operation.
Iterable<WorkRequestSummary>	listWorkRequestsRecordIterator(ListWorkRequestsRequest request) Creates a new iterable which will iterate over the WorkRequestSummary objects contained in responses from the listWorkRequests operation.
Iterable<ListWorkRequestsResponse>	listWorkRequestsResponseIterator(ListWorkRequestsRequest request) Creates a new iterable which will iterate over the responses received from the listWorkRequests operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFlowPaginators

public DataFlowPaginators(DataFlow client)

Method Detail

listApplicationsResponseIterator

public Iterable<ListApplicationsResponse> listApplicationsResponseIterator(ListApplicationsRequest request)

Creates a new iterable which will iterate over the responses received from the listApplications 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.

listApplicationsRecordIterator

public Iterable<ApplicationSummary> listApplicationsRecordIterator(ListApplicationsRequest request)

Creates a new iterable which will iterate over the ApplicationSummary objects contained in responses from the listApplications 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 ApplicationSummary objects contained in responses received from the service.

listPoolsResponseIterator

public Iterable<ListPoolsResponse> listPoolsResponseIterator(ListPoolsRequest request)

Creates a new iterable which will iterate over the responses received from the listPools 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.

listPoolsRecordIterator

public Iterable<PoolSummary> listPoolsRecordIterator(ListPoolsRequest request)

Creates a new iterable which will iterate over the PoolSummary objects contained in responses from the listPools 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 PoolSummary objects contained in responses received from the service.

listPrivateEndpointsResponseIterator

public Iterable<ListPrivateEndpointsResponse> listPrivateEndpointsResponseIterator(ListPrivateEndpointsRequest request)

Creates a new iterable which will iterate over the responses received from the listPrivateEndpoints 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.

listPrivateEndpointsRecordIterator

public Iterable<PrivateEndpointSummary> listPrivateEndpointsRecordIterator(ListPrivateEndpointsRequest request)

Creates a new iterable which will iterate over the PrivateEndpointSummary objects contained in responses from the listPrivateEndpoints 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 PrivateEndpointSummary objects contained in responses received from the service.

listRunLogsResponseIterator

public Iterable<ListRunLogsResponse> listRunLogsResponseIterator(ListRunLogsRequest request)

Creates a new iterable which will iterate over the responses received from the listRunLogs 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.

listRunLogsRecordIterator

public Iterable<RunLogSummary> listRunLogsRecordIterator(ListRunLogsRequest request)

Creates a new iterable which will iterate over the RunLogSummary objects contained in responses from the listRunLogs 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 RunLogSummary objects contained in responses received from the service.

listRunsResponseIterator

public Iterable<ListRunsResponse> listRunsResponseIterator(ListRunsRequest request)

Creates a new iterable which will iterate over the responses received from the listRuns 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.

listRunsRecordIterator

public Iterable<RunSummary> listRunsRecordIterator(ListRunsRequest request)

Creates a new iterable which will iterate over the RunSummary objects contained in responses from the listRuns 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 RunSummary objects contained in responses received from the service.

listSqlEndpointsResponseIterator

public Iterable<ListSqlEndpointsResponse> listSqlEndpointsResponseIterator(ListSqlEndpointsRequest request)

Creates a new iterable which will iterate over the responses received from the listSqlEndpoints 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.

listSqlEndpointsRecordIterator

public Iterable<SqlEndpointSummary> listSqlEndpointsRecordIterator(ListSqlEndpointsRequest request)

Creates a new iterable which will iterate over the SqlEndpointSummary objects contained in responses from the listSqlEndpoints 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 SqlEndpointSummary objects contained in responses received from the service.

listStatementsResponseIterator

public Iterable<ListStatementsResponse> listStatementsResponseIterator(ListStatementsRequest request)

Creates a new iterable which will iterate over the responses received from the listStatements 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.

listStatementsRecordIterator

public Iterable<StatementSummary> listStatementsRecordIterator(ListStatementsRequest request)

Creates a new iterable which will iterate over the StatementSummary objects contained in responses from the listStatements 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 StatementSummary objects contained in responses received from the service.

listWorkRequestErrorsResponseIterator

public Iterable<ListWorkRequestErrorsResponse> listWorkRequestErrorsResponseIterator(ListWorkRequestErrorsRequest request)

Creates a new iterable which will iterate over the responses received from the listWorkRequestErrors 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.

listWorkRequestErrorsRecordIterator

public Iterable<WorkRequestError> listWorkRequestErrorsRecordIterator(ListWorkRequestErrorsRequest request)

Creates a new iterable which will iterate over the WorkRequestError objects contained in responses from the listWorkRequestErrors 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 WorkRequestError objects contained in responses received from the service.

listWorkRequestLogsResponseIterator

public Iterable<ListWorkRequestLogsResponse> listWorkRequestLogsResponseIterator(ListWorkRequestLogsRequest request)

Creates a new iterable which will iterate over the responses received from the listWorkRequestLogs 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.

listWorkRequestLogsRecordIterator

public Iterable<WorkRequestLog> listWorkRequestLogsRecordIterator(ListWorkRequestLogsRequest request)

Creates a new iterable which will iterate over the WorkRequestLog objects contained in responses from the listWorkRequestLogs 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 WorkRequestLog objects contained in responses received from the service.

listWorkRequestsResponseIterator

public Iterable<ListWorkRequestsResponse> listWorkRequestsResponseIterator(ListWorkRequestsRequest request)

Creates a new iterable which will iterate over the responses received from the listWorkRequests 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.

listWorkRequestsRecordIterator

public Iterable<WorkRequestSummary> listWorkRequestsRecordIterator(ListWorkRequestsRequest request)

Creates a new iterable which will iterate over the WorkRequestSummary objects contained in responses from the listWorkRequests 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 WorkRequestSummary objects contained in responses received from the service.