Package com.oracle.bmc.marketplaceprivateoffer

Interface OfferAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OfferAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface OfferAsync
extends AutoCloseable
    Use the Marketplace Publisher API to manage the publishing of applications in Oracle Cloud Infrastructure Marketplace.

    • 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 serice.

      • 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

      • createOffer

        Future<CreateOfferResponse> createOffer​(CreateOfferRequest request,
                                        AsyncHandler<CreateOfferRequest,​CreateOfferResponse> handler)
        Creates a new Offer.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteOffer

        Future<DeleteOfferResponse> deleteOffer​(DeleteOfferRequest request,
                                        AsyncHandler<DeleteOfferRequest,​DeleteOfferResponse> handler)
        Deletes an Offer resource by identifier
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getOffer

        Future<GetOfferResponse> getOffer​(GetOfferRequest request,
                                  AsyncHandler<GetOfferRequest,​GetOfferResponse> handler)
        Gets an Offer by identifier
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getOfferInternalDetail

        Future<GetOfferInternalDetailResponse> getOfferInternalDetail​(GetOfferInternalDetailRequest request,
                                                              AsyncHandler<GetOfferInternalDetailRequest,​GetOfferInternalDetailResponse> handler)
        Gets an Offer internal details by identifier
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listOffers

        Future<ListOffersResponse> listOffers​(ListOffersRequest request,
                                      AsyncHandler<ListOffersRequest,​ListOffersResponse> handler)
        Returns a list of Offers.

        Requires either the BuyerCompartmentId or the SellerCompartmentId params. If neither or both are provided, then the API will return a 400.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateOffer

        Future<UpdateOfferResponse> updateOffer​(UpdateOfferRequest request,
                                        AsyncHandler<UpdateOfferRequest,​UpdateOfferResponse> handler)
        Updates the Offer
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.