com.oracle.bmc.marketplace

Interface MarketplaceAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

MarketplaceAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181001")
public interface MarketplaceAsync
extends AutoCloseable

Manage applications in Oracle Cloud Infrastructure Marketplace.

Method Summary

Modifier and Type	Method and Description
Future<CreateAcceptedAgreementResponse>	createAcceptedAgreement(CreateAcceptedAgreementRequest request, AsyncHandler<CreateAcceptedAgreementRequest,CreateAcceptedAgreementResponse> handler) Accepts a terms of use agreement for a specific package version of a listing.
Future<DeleteAcceptedAgreementResponse>	deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request, AsyncHandler<DeleteAcceptedAgreementRequest,DeleteAcceptedAgreementResponse> handler) Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment.
Future<GetAcceptedAgreementResponse>	getAcceptedAgreement(GetAcceptedAgreementRequest request, AsyncHandler<GetAcceptedAgreementRequest,GetAcceptedAgreementResponse> handler) Gets the details of a specific, previously accepted terms of use agreement.
Future<GetAgreementResponse>	getAgreement(GetAgreementRequest request, AsyncHandler<GetAgreementRequest,GetAgreementResponse> handler) Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetListingResponse>	getListing(GetListingRequest request, AsyncHandler<GetListingRequest,GetListingResponse> handler) Gets detailed information about a listing, including the listing’s name, version, description, and resources.
Future<GetPackageResponse>	getPackage(GetPackageRequest request, AsyncHandler<GetPackageRequest,GetPackageResponse> handler) Get the details of the specified version of a package, including information needed to launch the package.
Future<ListAcceptedAgreementsResponse>	listAcceptedAgreements(ListAcceptedAgreementsRequest request, AsyncHandler<ListAcceptedAgreementsRequest,ListAcceptedAgreementsResponse> handler) Lists the terms of use agreements that have been accepted in the specified compartment.
Future<ListAgreementsResponse>	listAgreements(ListAgreementsRequest request, AsyncHandler<ListAgreementsRequest,ListAgreementsResponse> handler) Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.
Future<ListCategoriesResponse>	listCategories(ListCategoriesRequest request, AsyncHandler<ListCategoriesRequest,ListCategoriesResponse> handler) Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace.
Future<ListListingsResponse>	listListings(ListListingsRequest request, AsyncHandler<ListListingsRequest,ListListingsResponse> handler) Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.
Future<ListPackagesResponse>	listPackages(ListPackagesRequest request, AsyncHandler<ListPackagesRequest,ListPackagesResponse> handler) Gets the list of packages for a listing.
Future<ListPublishersResponse>	listPublishers(ListPublishersRequest request, AsyncHandler<ListPublishersRequest,ListPublishersResponse> handler) Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.
Future<ListReportsResponse>	listReports(ListReportsRequest request, AsyncHandler<ListReportsRequest,ListReportsResponse> handler) Lists reports in the compartment that match the specified report type and date.
Future<ListReportTypesResponse>	listReportTypes(ListReportTypesRequest request, AsyncHandler<ListReportTypesRequest,ListReportTypesResponse> handler) Lists available types of reports for the compartment.
Future<ListTaxesResponse>	listTaxes(ListTaxesRequest request, AsyncHandler<ListTaxesRequest,ListTaxesResponse> handler) Returns list of all tax implications that current tenant may be liable to once they launch the listing.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateAcceptedAgreementResponse>	updateAcceptedAgreement(UpdateAcceptedAgreementRequest request, AsyncHandler<UpdateAcceptedAgreementRequest,UpdateAcceptedAgreementResponse> handler) Updates the display name or tags associated with a listing’s previously accepted terms of use agreement.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

createAcceptedAgreement

Future<CreateAcceptedAgreementResponse> createAcceptedAgreement(CreateAcceptedAgreementRequest request,
                                                                AsyncHandler<CreateAcceptedAgreementRequest,CreateAcceptedAgreementResponse> handler)

Accepts a terms of use agreement for a specific package version of a listing. You must accept all terms of use for a package before you can deploy the package.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteAcceptedAgreement

Future<DeleteAcceptedAgreementResponse> deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request,
                                                                AsyncHandler<DeleteAcceptedAgreementRequest,DeleteAcceptedAgreementResponse> handler)

Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment. Listings in the Marketplace that require acceptance of the specified terms of use can no longer be deployed, but existing deployments aren’t affected.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAcceptedAgreement

Future<GetAcceptedAgreementResponse> getAcceptedAgreement(GetAcceptedAgreementRequest request,
                                                          AsyncHandler<GetAcceptedAgreementRequest,GetAcceptedAgreementResponse> handler)

Gets the details of a specific, previously accepted terms of use agreement.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAgreement

Future<GetAgreementResponse> getAgreement(GetAgreementRequest request,
                                          AsyncHandler<GetAgreementRequest,GetAgreementResponse> handler)

Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getListing

Future<GetListingResponse> getListing(GetListingRequest request,
                                      AsyncHandler<GetListingRequest,GetListingResponse> handler)

Gets detailed information about a listing, including the listing’s name, version, description, and resources.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getPackage

Future<GetPackageResponse> getPackage(GetPackageRequest request,
                                      AsyncHandler<GetPackageRequest,GetPackageResponse> handler)

Get the details of the specified version of a package, including information needed to launch the package.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAcceptedAgreements

Future<ListAcceptedAgreementsResponse> listAcceptedAgreements(ListAcceptedAgreementsRequest request,
                                                              AsyncHandler<ListAcceptedAgreementsRequest,ListAcceptedAgreementsResponse> handler)

Lists the terms of use agreements that have been accepted in the specified compartment. You can filter results by specifying query parameters.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAgreements

Future<ListAgreementsResponse> listAgreements(ListAgreementsRequest request,
                                              AsyncHandler<ListAgreementsRequest,ListAgreementsResponse> handler)

Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listCategories

Future<ListCategoriesResponse> listCategories(ListCategoriesRequest request,
                                              AsyncHandler<ListCategoriesRequest,ListCategoriesResponse> handler)

Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace. Categories apply to the software product provided by the listing.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listListings

Future<ListListingsResponse> listListings(ListListingsRequest request,
                                          AsyncHandler<ListListingsRequest,ListListingsResponse> handler)

Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listPackages

Future<ListPackagesResponse> listPackages(ListPackagesRequest request,
                                          AsyncHandler<ListPackagesRequest,ListPackagesResponse> handler)

Gets the list of packages for a listing.

If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listPublishers

Future<ListPublishersResponse> listPublishers(ListPublishersRequest request,
                                              AsyncHandler<ListPublishersRequest,ListPublishersResponse> handler)

Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listReportTypes

Future<ListReportTypesResponse> listReportTypes(ListReportTypesRequest request,
                                                AsyncHandler<ListReportTypesRequest,ListReportTypesResponse> handler)

Lists available types of reports for the compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listReports

Future<ListReportsResponse> listReports(ListReportsRequest request,
                                        AsyncHandler<ListReportsRequest,ListReportsResponse> handler)

Lists reports in the compartment that match the specified report type and date.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listTaxes

Future<ListTaxesResponse> listTaxes(ListTaxesRequest request,
                                    AsyncHandler<ListTaxesRequest,ListTaxesResponse> handler)

Returns list of all tax implications that current tenant may be liable to once they launch the listing.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAcceptedAgreement

Future<UpdateAcceptedAgreementResponse> updateAcceptedAgreement(UpdateAcceptedAgreementRequest request,
                                                                AsyncHandler<UpdateAcceptedAgreementRequest,UpdateAcceptedAgreementResponse> handler)

Updates the display name or tags associated with a listing’s previously accepted terms of use agreement.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.