Class AccessGovernanceCPPaginators
- java.lang.Object
-
- com.oracle.bmc.accessgovernancecp.AccessGovernanceCPPaginators
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20220518") public class AccessGovernanceCPPaginators extends Object
Collection of helper methods that can be used to provide anIterable
interface to any list operations of AccessGovernanceCP 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 theIterable
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 Description AccessGovernanceCPPaginators(AccessGovernanceCP client)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Iterable<GovernanceInstanceSummary>
listGovernanceInstancesRecordIterator(ListGovernanceInstancesRequest request)
Creates a new iterable which will iterate over theGovernanceInstanceSummary
objects contained in responses from the listGovernanceInstances operation.Iterable<ListGovernanceInstancesResponse>
listGovernanceInstancesResponseIterator(ListGovernanceInstancesRequest request)
Creates a new iterable which will iterate over the responses received from the listGovernanceInstances operation.
-
-
-
Constructor Detail
-
AccessGovernanceCPPaginators
public AccessGovernanceCPPaginators(AccessGovernanceCP client)
-
-
Method Detail
-
listGovernanceInstancesResponseIterator
public Iterable<ListGovernanceInstancesResponse> listGovernanceInstancesResponseIterator(ListGovernanceInstancesRequest request)
Creates a new iterable which will iterate over the responses received from the listGovernanceInstances 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.
-
listGovernanceInstancesRecordIterator
public Iterable<GovernanceInstanceSummary> listGovernanceInstancesRecordIterator(ListGovernanceInstancesRequest request)
Creates a new iterable which will iterate over theGovernanceInstanceSummary
objects contained in responses from the listGovernanceInstances 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 theGovernanceInstanceSummary
objects contained in responses received from the service.
-
-