Package com.oracle.bmc.marketplacepublisher

Interface MarketplaceAdministrator

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    MarketplaceAdministratorClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20241201")
public interface MarketplaceAdministrator
extends AutoCloseable
    Use the Marketplace Publisher API to manage the publishing of applications in Oracle Cloud Infrastructure 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 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 call setEndpoint.

        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

      • changeListingRevisionStatusToNew

        ChangeListingRevisionStatusToNewResponse changeListingRevisionStatusToNew​(ChangeListingRevisionStatusToNewRequest request)
        Change the Listing Revision status to New
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ChangeListingRevisionStatusToNewExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeListingRevisionStatusToNew API.

      • createMarket

        CreateMarketResponse createMarket​(CreateMarketRequest request)
        Creates a new Market.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/CreateMarketExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateMarket API.

      • getAdminArtifact

        GetAdminArtifactResponse getAdminArtifact​(GetAdminArtifactRequest request)
        Gets the specified artifact’s information.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/GetAdminArtifactExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAdminArtifact API.

      • getAdminListing

        GetAdminListingResponse getAdminListing​(GetAdminListingRequest request)
        Returns details of 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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/GetAdminListingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAdminListing API.

      • getAdminListingRevision

        GetAdminListingRevisionResponse getAdminListingRevision​(GetAdminListingRevisionRequest request)
        Returns details of the Listing revision.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/GetAdminListingRevisionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAdminListingRevision API.

      • getAdminListingRevisionAttachment

        GetAdminListingRevisionAttachmentResponse getAdminListingRevisionAttachment​(GetAdminListingRevisionAttachmentRequest request)
        Get the details of the specified listing revision attachment.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/GetAdminListingRevisionAttachmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAdminListingRevisionAttachment API.

      • getAdminListingRevisionPackage

        GetAdminListingRevisionPackageResponse getAdminListingRevisionPackage​(GetAdminListingRevisionPackageRequest request)
        Get the details of 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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/GetAdminListingRevisionPackageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAdminListingRevisionPackage API.

      • getAdminTerm

        GetAdminTermResponse getAdminTerm​(GetAdminTermRequest request)
        Gets a Term by identifier
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/GetAdminTermExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAdminTerm API.

      • getAdminTermVersion

        GetAdminTermVersionResponse getAdminTermVersion​(GetAdminTermVersionRequest request)
        Gets a Term Version by the identifier
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/GetAdminTermVersionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAdminTermVersion API.

      • listAdminArtifacts

        ListAdminArtifactsResponse listAdminArtifacts​(ListAdminArtifactsRequest request)
        Lists the artifacts in your compartment.

        You must specify your compartment’s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).

        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminArtifactsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminArtifacts API.

      • listAdminListingRevisionAttachments

        ListAdminListingRevisionAttachmentsResponse listAdminListingRevisionAttachments​(ListAdminListingRevisionAttachmentsRequest request)
        Gets the list of attachments for a listing revision
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminListingRevisionAttachmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminListingRevisionAttachments API.

      • listAdminListingRevisionPackages

        ListAdminListingRevisionPackagesResponse listAdminListingRevisionPackages​(ListAdminListingRevisionPackagesRequest request)
        Gets the list of packages for a listing revision.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminListingRevisionPackagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminListingRevisionPackages API.

      • listAdminListingRevisions

        ListAdminListingRevisionsResponse listAdminListingRevisions​(ListAdminListingRevisionsRequest request)
        Returns a list of all the Listing revisions.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminListingRevisionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminListingRevisions API.

      • listAdminPublisherSkus

        ListAdminPublisherSkusResponse listAdminPublisherSkus​(ListAdminPublisherSkusRequest request)
        Retrieve a list of publisher SKUs
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminPublisherSkusExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminPublisherSkus API.

      • listAdminTermVersions

        ListAdminTermVersionsResponse listAdminTermVersions​(ListAdminTermVersionsRequest request)
        Returns a list of the publisher term versions.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminTermVersionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminTermVersions API.

      • listAdminTerms

        ListAdminTermsResponse listAdminTerms​(ListAdminTermsRequest request)
        Returns a list of the publisher terms.
        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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminTermsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminTerms API.

      • listAdminWorkRequests

        ListAdminWorkRequestsResponse listAdminWorkRequests​(ListAdminWorkRequestsRequest request)
        Lists the 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_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListAdminWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAdminWorkRequests API.

      • getPaginators

        MarketplaceAdministratorPaginators 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.