com.oracle.bmc.marketplace

Class MarketplacePaginators

java.lang.Object

com.oracle.bmc.marketplace.MarketplacePaginators

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

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

Method Summary

Modifier and Type	Method and Description
Iterable<AcceptedAgreementSummary>	listAcceptedAgreementsRecordIterator(ListAcceptedAgreementsRequest request) Creates a new iterable which will iterate over the AcceptedAgreementSummary objects contained in responses from the listAcceptedAgreements operation.
Iterable<ListAcceptedAgreementsResponse>	listAcceptedAgreementsResponseIterator(ListAcceptedAgreementsRequest request) Creates a new iterable which will iterate over the responses received from the listAcceptedAgreements operation.
Iterable<AgreementSummary>	listAgreementsRecordIterator(ListAgreementsRequest request) Creates a new iterable which will iterate over the AgreementSummary objects contained in responses from the listAgreements operation.
Iterable<ListAgreementsResponse>	listAgreementsResponseIterator(ListAgreementsRequest request) Creates a new iterable which will iterate over the responses received from the listAgreements operation.
Iterable<CategorySummary>	listCategoriesRecordIterator(ListCategoriesRequest request) Creates a new iterable which will iterate over the CategorySummary objects contained in responses from the listCategories operation.
Iterable<ListCategoriesResponse>	listCategoriesResponseIterator(ListCategoriesRequest request) Creates a new iterable which will iterate over the responses received from the listCategories operation.
Iterable<ListingSummary>	listListingsRecordIterator(ListListingsRequest request) Creates a new iterable which will iterate over the ListingSummary objects contained in responses from the listListings operation.
Iterable<ListListingsResponse>	listListingsResponseIterator(ListListingsRequest request) Creates a new iterable which will iterate over the responses received from the listListings operation.
Iterable<ListingPackageSummary>	listPackagesRecordIterator(ListPackagesRequest request) Creates a new iterable which will iterate over the ListingPackageSummary objects contained in responses from the listPackages operation.
Iterable<ListPackagesResponse>	listPackagesResponseIterator(ListPackagesRequest request) Creates a new iterable which will iterate over the responses received from the listPackages operation.
Iterable<PublicationPackageSummary>	listPublicationPackagesRecordIterator(ListPublicationPackagesRequest request) Creates a new iterable which will iterate over the PublicationPackageSummary objects contained in responses from the listPublicationPackages operation.
Iterable<ListPublicationPackagesResponse>	listPublicationPackagesResponseIterator(ListPublicationPackagesRequest request) Creates a new iterable which will iterate over the responses received from the listPublicationPackages operation.
Iterable<PublicationSummary>	listPublicationsRecordIterator(ListPublicationsRequest request) Creates a new iterable which will iterate over the PublicationSummary objects contained in responses from the listPublications operation.
Iterable<ListPublicationsResponse>	listPublicationsResponseIterator(ListPublicationsRequest request) Creates a new iterable which will iterate over the responses received from the listPublications operation.
Iterable<PublisherSummary>	listPublishersRecordIterator(ListPublishersRequest request) Creates a new iterable which will iterate over the PublisherSummary objects contained in responses from the listPublishers operation.
Iterable<ListPublishersResponse>	listPublishersResponseIterator(ListPublishersRequest request) Creates a new iterable which will iterate over the responses received from the listPublishers operation.
Iterable<ReportSummary>	listReportsRecordIterator(ListReportsRequest request) Creates a new iterable which will iterate over the ReportSummary objects contained in responses from the listReports operation.
Iterable<ListReportsResponse>	listReportsResponseIterator(ListReportsRequest request) Creates a new iterable which will iterate over the responses received from the listReports operation.
Iterable<ReportTypeSummary>	listReportTypesRecordIterator(ListReportTypesRequest request) Creates a new iterable which will iterate over the ReportTypeSummary objects contained in responses from the listReportTypes operation.
Iterable<ListReportTypesResponse>	listReportTypesResponseIterator(ListReportTypesRequest request) Creates a new iterable which will iterate over the responses received from the listReportTypes operation.
Iterable<ListingSummary>	searchListingsRecordIterator(SearchListingsRequest request) Creates a new iterable which will iterate over the ListingSummary objects contained in responses from the searchListings operation.
Iterable<SearchListingsResponse>	searchListingsResponseIterator(SearchListingsRequest request) Creates a new iterable which will iterate over the responses received from the searchListings operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarketplacePaginators

@ConstructorProperties(value="client")
public MarketplacePaginators(Marketplace client)

Method Detail

listAcceptedAgreementsResponseIterator

public Iterable<ListAcceptedAgreementsResponse> listAcceptedAgreementsResponseIterator(ListAcceptedAgreementsRequest request)

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

listAcceptedAgreementsRecordIterator

public Iterable<AcceptedAgreementSummary> listAcceptedAgreementsRecordIterator(ListAcceptedAgreementsRequest request)

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

listAgreementsResponseIterator

public Iterable<ListAgreementsResponse> listAgreementsResponseIterator(ListAgreementsRequest request)

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

listAgreementsRecordIterator

public Iterable<AgreementSummary> listAgreementsRecordIterator(ListAgreementsRequest request)

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

listCategoriesResponseIterator

public Iterable<ListCategoriesResponse> listCategoriesResponseIterator(ListCategoriesRequest request)

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

listCategoriesRecordIterator

public Iterable<CategorySummary> listCategoriesRecordIterator(ListCategoriesRequest request)

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

listListingsResponseIterator

public Iterable<ListListingsResponse> listListingsResponseIterator(ListListingsRequest request)

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

listListingsRecordIterator

public Iterable<ListingSummary> listListingsRecordIterator(ListListingsRequest request)

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

listPackagesResponseIterator

public Iterable<ListPackagesResponse> listPackagesResponseIterator(ListPackagesRequest request)

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

listPackagesRecordIterator

public Iterable<ListingPackageSummary> listPackagesRecordIterator(ListPackagesRequest request)

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

listPublicationPackagesResponseIterator

public Iterable<ListPublicationPackagesResponse> listPublicationPackagesResponseIterator(ListPublicationPackagesRequest request)

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

listPublicationPackagesRecordIterator

public Iterable<PublicationPackageSummary> listPublicationPackagesRecordIterator(ListPublicationPackagesRequest request)

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

listPublicationsResponseIterator

public Iterable<ListPublicationsResponse> listPublicationsResponseIterator(ListPublicationsRequest request)

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

listPublicationsRecordIterator

public Iterable<PublicationSummary> listPublicationsRecordIterator(ListPublicationsRequest request)

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

listPublishersResponseIterator

public Iterable<ListPublishersResponse> listPublishersResponseIterator(ListPublishersRequest request)

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

listPublishersRecordIterator

public Iterable<PublisherSummary> listPublishersRecordIterator(ListPublishersRequest request)

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

listReportTypesResponseIterator

public Iterable<ListReportTypesResponse> listReportTypesResponseIterator(ListReportTypesRequest request)

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

listReportTypesRecordIterator

public Iterable<ReportTypeSummary> listReportTypesRecordIterator(ListReportTypesRequest request)

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

listReportsResponseIterator

public Iterable<ListReportsResponse> listReportsResponseIterator(ListReportsRequest request)

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

listReportsRecordIterator

public Iterable<ReportSummary> listReportsRecordIterator(ListReportsRequest request)

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

searchListingsResponseIterator

public Iterable<SearchListingsResponse> searchListingsResponseIterator(SearchListingsRequest request)

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

searchListingsRecordIterator

public Iterable<ListingSummary> searchListingsRecordIterator(SearchListingsRequest request)

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