com.oracle.bmc.marketplace

Interface Marketplace

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

MarketplaceClient

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

Manage applications in Oracle Cloud Infrastructure Marketplace.

Method Summary

Modifier and Type	Method and Description
CreateAcceptedAgreementResponse	createAcceptedAgreement(CreateAcceptedAgreementRequest request) Accepts a terms of use agreement for a specific package version of a listing.
DeleteAcceptedAgreementResponse	deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request) Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment.
GetAcceptedAgreementResponse	getAcceptedAgreement(GetAcceptedAgreementRequest request) Gets the details of a specific, previously accepted terms of use agreement.
GetAgreementResponse	getAgreement(GetAgreementRequest request) 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)
GetListingResponse	getListing(GetListingRequest request) Gets detailed information about a listing, including the listing’s name, version, description, and resources.
GetPackageResponse	getPackage(GetPackageRequest request) Get the details of the specified version of a package, including information needed to launch the package.
MarketplacePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListAcceptedAgreementsResponse	listAcceptedAgreements(ListAcceptedAgreementsRequest request) Lists the terms of use agreements that have been accepted in the specified compartment.
ListAgreementsResponse	listAgreements(ListAgreementsRequest request) Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.
ListCategoriesResponse	listCategories(ListCategoriesRequest request) Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace.
ListListingsResponse	listListings(ListListingsRequest request) Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.
ListPackagesResponse	listPackages(ListPackagesRequest request) Gets the list of packages for a listing.
ListPublishersResponse	listPublishers(ListPublishersRequest request) Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.
ListReportsResponse	listReports(ListReportsRequest request) Lists reports in the compartment that match the specified report type and date.
ListReportTypesResponse	listReportTypes(ListReportTypesRequest request) Lists available types of reports for the compartment.
ListTaxesResponse	listTaxes(ListTaxesRequest request) 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’).
UpdateAcceptedAgreementResponse	updateAcceptedAgreement(UpdateAcceptedAgreementRequest request) 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 service.

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

CreateAcceptedAgreementResponse createAcceptedAgreement(CreateAcceptedAgreementRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateAcceptedAgreement API.

deleteAcceptedAgreement

DeleteAcceptedAgreementResponse deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteAcceptedAgreement API.

getAcceptedAgreement

GetAcceptedAgreementResponse getAcceptedAgreement(GetAcceptedAgreementRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetAcceptedAgreement API.

getAgreement

GetAgreementResponse getAgreement(GetAgreementRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetAgreement API.

getListing

GetListingResponse getListing(GetListingRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetListing API.

getPackage

GetPackageResponse getPackage(GetPackageRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetPackage API.

listAcceptedAgreements

ListAcceptedAgreementsResponse listAcceptedAgreements(ListAcceptedAgreementsRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListAcceptedAgreements API.

listAgreements

ListAgreementsResponse listAgreements(ListAgreementsRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListAgreements API.

listCategories

ListCategoriesResponse listCategories(ListCategoriesRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListCategories API.

listListings

ListListingsResponse listListings(ListListingsRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListListings API.

listPackages

ListPackagesResponse listPackages(ListPackagesRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListPackages API.

listPublishers

ListPublishersResponse listPublishers(ListPublishersRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListPublishers API.

listReportTypes

ListReportTypesResponse listReportTypes(ListReportTypesRequest request)

Lists available types of reports for the compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListReportTypes API.

listReports

ListReportsResponse listReports(ListReportsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListReports API.

listTaxes

ListTaxesResponse listTaxes(ListTaxesRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListTaxes API.

updateAcceptedAgreement

UpdateAcceptedAgreementResponse updateAcceptedAgreement(UpdateAcceptedAgreementRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateAcceptedAgreement API.

getPaginators

MarketplacePaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.