@Generated(value="OracleSDKGenerator",
comments="API Version: 20220509")
public class CommonPaginators
extends Object
Collection of helper methods that can be used to provide an Iterable interface
to any list operations of Common where multiple pages of data may be fetched. Two styles of
iteration are supported:
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 and Description |
|---|
CommonPaginators(Common client) |
| Modifier and Type | Method and Description |
|---|---|
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<WorkRequestLogEntry> |
listWorkRequestLogsRecordIterator(ListWorkRequestLogsRequest request)
Creates a new iterable which will iterate over the
WorkRequestLogEntry 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.
|
public CommonPaginators(Common client)
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.
request - a request which can be sent to the service operationIterable which can be used to iterate over the responses
received from the service.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.
request - a request which can be sent to the service operationIterable which can be used to iterate over the WorkRequestError objects contained in responses
received from the service.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.
request - a request which can be sent to the service operationIterable which can be used to iterate over the responses
received from the service.public Iterable<WorkRequestLogEntry> listWorkRequestLogsRecordIterator(ListWorkRequestLogsRequest request)
Creates a new iterable which will iterate over the WorkRequestLogEntry objects contained in responses from the
listWorkRequestLogs operation. This iterable will fetch more data from the server as needed.
request - a request which can be sent to the service operationIterable which can be used to iterate over the WorkRequestLogEntry objects contained in responses
received from the service.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.
request - a request which can be sent to the service operationIterable which can be used to iterate over the responses
received from the service.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.
request - a request which can be sent to the service operationIterable which can be used to iterate over the WorkRequestSummary objects contained in responses
received from the service.Copyright © 2016–2024. All rights reserved.