@Generated(value="OracleSDKGenerator", comments="API Version: 20190501") public class ApiGatewayPaginators extends Object
Collection of helper methods that can be used to provide an Iterable
interface
to any list operations of ApiGateway 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 |
---|
ApiGatewayPaginators(ApiGateway client) |
Modifier and Type | Method and Description |
---|---|
Iterable<ApiSummary> |
listApisRecordIterator(ListApisRequest request)
Creates a new iterable which will iterate over the
ApiSummary objects
contained in responses from the listApis operation. |
Iterable<ListApisResponse> |
listApisResponseIterator(ListApisRequest request)
Creates a new iterable which will iterate over the responses received from the listApis operation.
|
Iterable<CertificateSummary> |
listCertificatesRecordIterator(ListCertificatesRequest request)
Creates a new iterable which will iterate over the
CertificateSummary objects
contained in responses from the listCertificates operation. |
Iterable<ListCertificatesResponse> |
listCertificatesResponseIterator(ListCertificatesRequest request)
Creates a new iterable which will iterate over the responses received from the listCertificates operation.
|
Iterable<SdkLanguageTypeSummary> |
listSdkLanguageTypesRecordIterator(ListSdkLanguageTypesRequest request)
Creates a new iterable which will iterate over the
SdkLanguageTypeSummary objects
contained in responses from the listSdkLanguageTypes operation. |
Iterable<ListSdkLanguageTypesResponse> |
listSdkLanguageTypesResponseIterator(ListSdkLanguageTypesRequest request)
Creates a new iterable which will iterate over the responses received from the listSdkLanguageTypes operation.
|
Iterable<SdkSummary> |
listSdksRecordIterator(ListSdksRequest request)
Creates a new iterable which will iterate over the
SdkSummary objects
contained in responses from the listSdks operation. |
Iterable<ListSdksResponse> |
listSdksResponseIterator(ListSdksRequest request)
Creates a new iterable which will iterate over the responses received from the listSdks operation.
|
@ConstructorProperties(value="client") public ApiGatewayPaginators(ApiGateway client)
public Iterable<ListApisResponse> listApisResponseIterator(ListApisRequest request)
Creates a new iterable which will iterate over the responses received from the listApis 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<ApiSummary> listApisRecordIterator(ListApisRequest request)
Creates a new iterable which will iterate over the ApiSummary
objects
contained in responses from the listApis 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 ApiSummary
objects
contained in responses received from the service.public Iterable<ListCertificatesResponse> listCertificatesResponseIterator(ListCertificatesRequest request)
Creates a new iterable which will iterate over the responses received from the listCertificates 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<CertificateSummary> listCertificatesRecordIterator(ListCertificatesRequest request)
Creates a new iterable which will iterate over the CertificateSummary
objects
contained in responses from the listCertificates 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 CertificateSummary
objects
contained in responses received from the service.public Iterable<ListSdkLanguageTypesResponse> listSdkLanguageTypesResponseIterator(ListSdkLanguageTypesRequest request)
Creates a new iterable which will iterate over the responses received from the listSdkLanguageTypes 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<SdkLanguageTypeSummary> listSdkLanguageTypesRecordIterator(ListSdkLanguageTypesRequest request)
Creates a new iterable which will iterate over the SdkLanguageTypeSummary
objects
contained in responses from the listSdkLanguageTypes 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 SdkLanguageTypeSummary
objects
contained in responses received from the service.public Iterable<ListSdksResponse> listSdksResponseIterator(ListSdksRequest request)
Creates a new iterable which will iterate over the responses received from the listSdks 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<SdkSummary> listSdksRecordIterator(ListSdksRequest request)
Creates a new iterable which will iterate over the SdkSummary
objects
contained in responses from the listSdks 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 SdkSummary
objects
contained in responses received from the service.Copyright © 2016–2022. All rights reserved.