Interface Offer
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
OfferClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20220901") public interface Offer 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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateOfferResponse
createOffer(CreateOfferRequest request)
Creates a new Offer.DeleteOfferResponse
deleteOffer(DeleteOfferRequest request)
Deletes an Offer resource by identifierString
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)GetOfferResponse
getOffer(GetOfferRequest request)
Gets an Offer by identifierGetOfferInternalDetailResponse
getOfferInternalDetail(GetOfferInternalDetailRequest request)
Gets an Offer internal details by identifierOfferPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.OfferWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListOffersResponse
listOffers(ListOffersRequest request)
Returns a list of Offers.void
refreshClient()
Rebuilds the client from scratch.void
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).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’).UpdateOfferResponse
updateOffer(UpdateOfferRequest request)
Updates the Offervoid
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
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 callsetEndpoint
.- 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
CreateOfferResponse createOffer(CreateOfferRequest request)
Creates a new Offer.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplaceprivateoffer/CreateOfferExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOffer API.
-
deleteOffer
DeleteOfferResponse deleteOffer(DeleteOfferRequest request)
Deletes an Offer 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplaceprivateoffer/DeleteOfferExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOffer API.
-
getOffer
GetOfferResponse getOffer(GetOfferRequest request)
Gets an Offer 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplaceprivateoffer/GetOfferExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOffer API.
-
getOfferInternalDetail
GetOfferInternalDetailResponse getOfferInternalDetail(GetOfferInternalDetailRequest request)
Gets an Offer 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplaceprivateoffer/GetOfferInternalDetailExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOfferInternalDetail API.
-
listOffers
ListOffersResponse listOffers(ListOffersRequest request)
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- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplaceprivateoffer/ListOffersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOffers API.
-
updateOffer
UpdateOfferResponse updateOffer(UpdateOfferRequest request)
Updates the Offer- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/marketplaceprivateoffer/UpdateOfferExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOffer API.
-
getWaiters
OfferWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
OfferPaginators 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.
-
-