Package com.oracle.bmc.marketplace

Class MarketplaceClient

    • Field Detail

      • SERVICE

        public static final Service SERVICE
        Service instance for Marketplace.

      • clientCommonLibraryVersion

        public final String clientCommonLibraryVersion
        Compatible SDK version, provided by the codegen.

      • minimumClientCommonLibraryVersionFromClient

        public final Optional<String> minimumClientCommonLibraryVersionFromClient
        Minimum compatible SDK version, maybe provided by the codegen.

    • Method Detail

      • 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 interface Marketplace
        Parameters:
        region - The region of the service.

      • 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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        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 interface Marketplace
        Returns:
        The service paginators.

      • enableDualStackEndpoints

        public void enableDualStackEndpoints​(boolean enableDualStackEndpoints)
        This method should be used to enable or disable the use of dual-stack endpoints.

        The default value is false i.e. dual-stack endpoints are disabled by default.

        Parameters:
        enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

      • getOptionsMap

        public Map<String,​Boolean> getOptionsMap()
        Return an immutable snapshot representing the current options set for this client.
        Returns:
        immutable snapshot representing the current options set for this client

      • getResolvedEndpoint

        public String getResolvedEndpoint​(Map<String,​Object> requiredParametersMap)
        Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
        Parameters:
        requiredParametersMap - the map from required parameter name to their values
        Returns:
        resolved endpoint, with all options and placeholders filled in

      • 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

      • setEndpoint

        public final void setEndpoint​(String endpoint)

      • getEndpoint

        public final String getEndpoint()
        Get the endpoint of the client.

        Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

        Examples of endpoints this may return:

        • Unparameterized endpoints 
                       https://identity.us-phoenix-1.oci.oraclecloud.com
             https://identity.us-ashburn-1.oci.oraclecloud.com
             https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with placeholders 
                       https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with options 
                       https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
             https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
        • Parameterized endpoints with placeholders and options 
                       https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com

        To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

        Returns:
        the endpoint being used by the client

      • refreshClient

        public final void refreshClient()
        Rebuild the backing HttpClient.

        This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()

      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()