Package com.oracle.bmc.marketplaceprivateoffer

Interface OfferQuote

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OfferQuoteClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface OfferQuote
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

      • createOfferQuote

        CreateOfferQuoteResponse createOfferQuote​(CreateOfferQuoteRequest request)
        Creates a new offer quote.
        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/marketplaceprivateoffer/CreateOfferQuoteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOfferQuote API.

      • deleteOfferQuote

        DeleteOfferQuoteResponse deleteOfferQuote​(DeleteOfferQuoteRequest request)
        Deletes an offer quote resource 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/marketplaceprivateoffer/DeleteOfferQuoteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOfferQuote API.

      • getOfferQuote

        GetOfferQuoteResponse getOfferQuote​(GetOfferQuoteRequest request)
        Gets an offer quote 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/marketplaceprivateoffer/GetOfferQuoteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOfferQuote API.

      • getOfferQuoteInternalDetail

        GetOfferQuoteInternalDetailResponse getOfferQuoteInternalDetail​(GetOfferQuoteInternalDetailRequest request)
        Gets an offer quote internal details 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/marketplaceprivateoffer/GetOfferQuoteInternalDetailExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOfferQuoteInternalDetail API.

      • listOfferQuotes

        ListOfferQuotesResponse listOfferQuotes​(ListOfferQuotesRequest request)
        Returns a list of offer quotes.

        Requires either a reseller compartment ID or an ISV compartment ID.

        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/marketplaceprivateoffer/ListOfferQuotesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOfferQuotes API.

      • respondToOfferQuote

        RespondToOfferQuoteResponse respondToOfferQuote​(RespondToOfferQuoteRequest request)
        ISV responds to an offer quote for reseller to review.
        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/marketplaceprivateoffer/RespondToOfferQuoteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RespondToOfferQuote API.

      • sendOfferQuote

        SendOfferQuoteResponse sendOfferQuote​(SendOfferQuoteRequest request)
        Sends an offer quote to be reviewed and updated by the ISV.

        Validation will be run on the offer quote first to verify it is valid and contains all required fields.

        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/marketplaceprivateoffer/SendOfferQuoteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SendOfferQuote API.

      • updateOfferQuote

        UpdateOfferQuoteResponse updateOfferQuote​(UpdateOfferQuoteRequest request)
        Updates the offer quote.
        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/marketplaceprivateoffer/UpdateOfferQuoteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOfferQuote API.

      • withdrawOfferQuote

        WithdrawOfferQuoteResponse withdrawOfferQuote​(WithdrawOfferQuoteRequest request)
        Withdraws an offer quote and transitions to previous state.

        Offer quotes can only be withdrawn by reseller before the ISV response and withdrawn by the ISV before reseller acceptance.

        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/marketplaceprivateoffer/WithdrawOfferQuoteExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use WithdrawOfferQuote API.

      • getWaiters

        OfferQuoteWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

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