@Generated(value="OracleSDKGenerator", comments="API Version: release") public class KmsVaultPaginators extends Object
Collection of helper methods that can be used to provide an Iterable interface
to any list operations of KmsVault 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 |
|---|
KmsVaultPaginators(KmsVault client) |
| Modifier and Type | Method and Description |
|---|---|
Iterable<VaultReplicaSummary> |
listVaultReplicasRecordIterator(ListVaultReplicasRequest request)
Creates a new iterable which will iterate over the
VaultReplicaSummary objects
contained in responses from the listVaultReplicas operation. |
Iterable<ListVaultReplicasResponse> |
listVaultReplicasResponseIterator(ListVaultReplicasRequest request)
Creates a new iterable which will iterate over the responses received from the listVaultReplicas operation.
|
Iterable<VaultSummary> |
listVaultsRecordIterator(ListVaultsRequest request)
Creates a new iterable which will iterate over the
VaultSummary objects
contained in responses from the listVaults operation. |
Iterable<ListVaultsResponse> |
listVaultsResponseIterator(ListVaultsRequest request)
Creates a new iterable which will iterate over the responses received from the listVaults operation.
|
public KmsVaultPaginators(KmsVault client)
public Iterable<ListVaultReplicasResponse> listVaultReplicasResponseIterator(ListVaultReplicasRequest request)
Creates a new iterable which will iterate over the responses received from the listVaultReplicas 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<VaultReplicaSummary> listVaultReplicasRecordIterator(ListVaultReplicasRequest request)
Creates a new iterable which will iterate over the VaultReplicaSummary objects
contained in responses from the listVaultReplicas 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 VaultReplicaSummary objects
contained in responses received from the service.public Iterable<ListVaultsResponse> listVaultsResponseIterator(ListVaultsRequest request)
Creates a new iterable which will iterate over the responses received from the listVaults 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<VaultSummary> listVaultsRecordIterator(ListVaultsRequest request)
Creates a new iterable which will iterate over the VaultSummary objects
contained in responses from the listVaults 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 VaultSummary objects
contained in responses received from the service.Copyright © 2016–2022. All rights reserved.