Interface Marketplace
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
MarketplaceClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20181001") public interface Marketplace extends AutoCloseable
Use the Marketplace API to manage applications in Oracle Cloud Infrastructure Marketplace.For more information, see Overview of Marketplace This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ChangePublicationCompartmentResponse
changePublicationCompartment(ChangePublicationCompartmentRequest request)
Moves the specified publication from one compartment to another.CreateAcceptedAgreementResponse
createAcceptedAgreement(CreateAcceptedAgreementRequest request)
Accepts a terms of use agreement for a specific package version of a listing.CreatePublicationResponse
createPublication(CreatePublicationRequest request)
Creates a publication of the specified listing type with an optional default package.DeleteAcceptedAgreementResponse
deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request)
Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment.DeletePublicationResponse
deletePublication(DeletePublicationRequest request)
Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.ExportListingResponse
exportListing(ExportListingRequest request)
Exports container images or helm chart from marketplace to customer’s registry.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.GetPublicationResponse
getPublication(GetPublicationRequest request)
Gets the details of the specified publication.GetPublicationPackageResponse
getPublicationPackage(GetPublicationPackageRequest request)
Gets the details of a specific package version within a given publication.MarketplaceWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Gets the details of the specified work requestListAcceptedAgreementsResponse
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.ListPublicationPackagesResponse
listPublicationPackages(ListPublicationPackagesRequest request)
Lists the packages in the specified publication.ListPublicationsResponse
listPublications(ListPublicationsRequest request)
Lists the publications in the specified compartment.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.ListWorkRequestErrorsResponse
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
List all errors for a work requestListWorkRequestLogsResponse
listWorkRequestLogs(ListWorkRequestLogsRequest request)
List all logs for a work requestListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
List all work requests in a compartmentvoid
refreshClient()
Rebuilds the client from scratch.SearchListingsResponse
searchListings(SearchListingsRequest request)
Queries all Marketplace Applications to find listings that match the specified criteria.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.UpdatePublicationResponse
updatePublication(UpdatePublicationRequest request)
Updates the details of an existing publication.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
changePublicationCompartment
ChangePublicationCompartmentResponse changePublicationCompartment(ChangePublicationCompartmentRequest request)
Moves the specified publication from one compartment to another.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ChangePublicationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangePublicationCompartment API.
-
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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/CreateAcceptedAgreementExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAcceptedAgreement API.
-
createPublication
CreatePublicationResponse createPublication(CreatePublicationRequest request)
Creates a publication of the specified listing type with an optional default 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/CreatePublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePublication 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 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/DeleteAcceptedAgreementExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAcceptedAgreement API.
-
deletePublication
DeletePublicationResponse deletePublication(DeletePublicationRequest request)
Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/DeletePublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePublication API.
-
exportListing
ExportListingResponse exportListing(ExportListingRequest request)
Exports container images or helm chart from marketplace to customer’s registry.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ExportListingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportListing 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/GetAcceptedAgreementExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/GetAgreementExample.java.html"target=”_blank"rel=“noopener noreferrer”>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.oracle.com/iaas/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/GetListingExample.java.html"target=”_blank"rel=“noopener noreferrer”>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.oracle.com/iaas/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/GetPackageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPackage API.
-
getPublication
GetPublicationResponse getPublication(GetPublicationRequest request)
Gets the details of the specified publication.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/GetPublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPublication API.
-
getPublicationPackage
GetPublicationPackageResponse getPublicationPackage(GetPublicationPackageRequest request)
Gets the details of a specific package version within a given publication.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/GetPublicationPackageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPublicationPackage API.
-
getWorkRequest
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the details of the specified work request- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListAcceptedAgreementsExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListAgreementsExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListCategoriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>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.oracle.com/iaas/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListListingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>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.oracle.com/iaas/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListPackagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPackages API.
-
listPublicationPackages
ListPublicationPackagesResponse listPublicationPackages(ListPublicationPackagesRequest request)
Lists the packages in the specified publication.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListPublicationPackagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPublicationPackages API.
-
listPublications
ListPublicationsResponse listPublications(ListPublicationsRequest request)
Lists the publications in the specified 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListPublicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPublications 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListPublishersExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListReportTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListReportsExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListTaxesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaxes API.
-
listWorkRequestErrors
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
List all errors for a work request- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
-
listWorkRequestLogs
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
List all logs for a work request- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
-
listWorkRequests
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
List all work requests in a 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
searchListings
SearchListingsResponse searchListings(SearchListingsRequest request)
Queries all Marketplace Applications to find listings that match the specified criteria.To search for a listing, you can use a free text or structured search.
- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/SearchListingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SearchListings 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/UpdateAcceptedAgreementExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAcceptedAgreement API.
-
updatePublication
UpdatePublicationResponse updatePublication(UpdatePublicationRequest request)
Updates the details of an existing publication.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplace/UpdatePublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePublication API.
-
getWaiters
MarketplaceWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
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.
-
-