Class MarketplaceClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.marketplace.MarketplaceClient
-
- All Implemented Interfaces:
Marketplace
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20181001") public class MarketplaceClient extends BaseSyncClient implements Marketplace
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MarketplaceClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for Marketplace.
-
Constructor Summary
Constructors Constructor Description MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MarketplaceClient.Builder
builder()
Create a builder for this client.ChangePublicationCompartmentResponse
changePublicationCompartment(ChangePublicationCompartmentRequest request)
Moves the specified publication from one compartment to another.void
close()
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
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
GetListingResponse
getListing(GetListingRequest request)
Gets detailed information about a listing, including the listing’s name, version, description, and resources.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.SearchListingsResponse
searchListings(SearchListingsRequest request)
Queries all Marketplace Applications to find listings that match the specified criteria.void
setEndpoint(String endpoint)
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.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdatePublicationResponse
updatePublication(UpdatePublicationRequest request)
Updates the details of an existing publication.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.marketplace.Marketplace
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
MarketplaceClient
@Deprecated public MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
MarketplaceClient
@Deprecated public MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
MarketplaceClient
@Deprecated public MarketplaceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
MarketplaceClient
@Deprecated public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
MarketplaceClient
@Deprecated public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
MarketplaceClient
@Deprecated public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
MarketplaceClient
@Deprecated public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
MarketplaceClient
@Deprecated public MarketplaceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMarketplaceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-MarketplaceClient.Builder.executorService
-
-
Method Detail
-
builder
public static MarketplaceClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:Marketplace
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.- Specified by:
setRegion
in interfaceMarketplace
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:Marketplace
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
.- Specified by:
setRegion
in interfaceMarketplace
- Parameters:
regionId
- The public region ID.
-
changePublicationCompartment
public ChangePublicationCompartmentResponse changePublicationCompartment(ChangePublicationCompartmentRequest request)
Description copied from interface:Marketplace
Moves the specified publication from one compartment to another.- Specified by:
changePublicationCompartment
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAcceptedAgreement
public CreateAcceptedAgreementResponse createAcceptedAgreement(CreateAcceptedAgreementRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
createAcceptedAgreement
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPublication
public CreatePublicationResponse createPublication(CreatePublicationRequest request)
Description copied from interface:Marketplace
Creates a publication of the specified listing type with an optional default package.- Specified by:
createPublication
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAcceptedAgreement
public DeleteAcceptedAgreementResponse deleteAcceptedAgreement(DeleteAcceptedAgreementRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
deleteAcceptedAgreement
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePublication
public DeletePublicationResponse deletePublication(DeletePublicationRequest request)
Description copied from interface:Marketplace
Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.- Specified by:
deletePublication
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportListing
public ExportListingResponse exportListing(ExportListingRequest request)
Description copied from interface:Marketplace
Exports container images or helm chart from marketplace to customer’s registry.- Specified by:
exportListing
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAcceptedAgreement
public GetAcceptedAgreementResponse getAcceptedAgreement(GetAcceptedAgreementRequest request)
Description copied from interface:Marketplace
Gets the details of a specific, previously accepted terms of use agreement.- Specified by:
getAcceptedAgreement
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAgreement
public GetAgreementResponse getAgreement(GetAgreementRequest request)
Description copied from interface:Marketplace
Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.- Specified by:
getAgreement
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getListing
public GetListingResponse getListing(GetListingRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
getListing
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPackage
public GetPackageResponse getPackage(GetPackageRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
getPackage
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPublication
public GetPublicationResponse getPublication(GetPublicationRequest request)
Description copied from interface:Marketplace
Gets the details of the specified publication.- Specified by:
getPublication
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPublicationPackage
public GetPublicationPackageResponse getPublicationPackage(GetPublicationPackageRequest request)
Description copied from interface:Marketplace
Gets the details of a specific package version within a given publication.- Specified by:
getPublicationPackage
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:Marketplace
Gets the details of the specified work request- Specified by:
getWorkRequest
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAcceptedAgreements
public ListAcceptedAgreementsResponse listAcceptedAgreements(ListAcceptedAgreementsRequest request)
Description copied from interface:Marketplace
Lists the terms of use agreements that have been accepted in the specified compartment.You can filter results by specifying query parameters.
- Specified by:
listAcceptedAgreements
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAgreements
public ListAgreementsResponse listAgreements(ListAgreementsRequest request)
Description copied from interface:Marketplace
Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.- Specified by:
listAgreements
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCategories
public ListCategoriesResponse listCategories(ListCategoriesRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
listCategories
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listListings
public ListListingsResponse listListings(ListListingsRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
listListings
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPackages
public ListPackagesResponse listPackages(ListPackagesRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
listPackages
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPublicationPackages
public ListPublicationPackagesResponse listPublicationPackages(ListPublicationPackagesRequest request)
Description copied from interface:Marketplace
Lists the packages in the specified publication.- Specified by:
listPublicationPackages
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPublications
public ListPublicationsResponse listPublications(ListPublicationsRequest request)
Description copied from interface:Marketplace
Lists the publications in the specified compartment.- Specified by:
listPublications
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPublishers
public ListPublishersResponse listPublishers(ListPublishersRequest request)
Description copied from interface:Marketplace
Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.- Specified by:
listPublishers
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReportTypes
public ListReportTypesResponse listReportTypes(ListReportTypesRequest request)
Description copied from interface:Marketplace
Lists available types of reports for the compartment.- Specified by:
listReportTypes
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReports
public ListReportsResponse listReports(ListReportsRequest request)
Description copied from interface:Marketplace
Lists reports in the compartment that match the specified report type and date.- Specified by:
listReports
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTaxes
public ListTaxesResponse listTaxes(ListTaxesRequest request)
Description copied from interface:Marketplace
Returns list of all tax implications that current tenant may be liable to once they launch the listing.- Specified by:
listTaxes
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:Marketplace
List all errors for a work request- Specified by:
listWorkRequestErrors
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:Marketplace
List all logs for a work request- Specified by:
listWorkRequestLogs
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:Marketplace
List all work requests in a compartment- Specified by:
listWorkRequests
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
searchListings
public SearchListingsResponse searchListings(SearchListingsRequest request)
Description copied from interface:Marketplace
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.
- Specified by:
searchListings
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAcceptedAgreement
public UpdateAcceptedAgreementResponse updateAcceptedAgreement(UpdateAcceptedAgreementRequest request)
Description copied from interface:Marketplace
Updates the display name or tags associated with a listing’s previously accepted terms of use agreement.- Specified by:
updateAcceptedAgreement
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePublication
public UpdatePublicationResponse updatePublication(UpdatePublicationRequest request)
Description copied from interface:Marketplace
Updates the details of an existing publication.- Specified by:
updatePublication
in interfaceMarketplace
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public MarketplaceWaiters getWaiters()
Description copied from interface:Marketplace
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceMarketplace
- Returns:
- The service waiters.
-
getPaginators
public MarketplacePaginators getPaginators()
Description copied from interface:Marketplace
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.- Specified by:
getPaginators
in interfaceMarketplace
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-