@Generated(value="OracleSDKGenerator",
comments="API Version: 20210527")
public interface ServiceCatalog
extends AutoCloseable
Manage solutions in Oracle Cloud Infrastructure Service Catalog. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
closevoid refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint - The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region - The region of the service.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.
regionId - The public region ID.BulkReplaceServiceCatalogAssociationsResponse bulkReplaceServiceCatalogAssociations(BulkReplaceServiceCatalogAssociationsRequest request)
Replace all associations of a given service catalog in one bulk transaction.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use BulkReplaceServiceCatalogAssociations API.
ChangePrivateApplicationCompartmentResponse changePrivateApplicationCompartment(ChangePrivateApplicationCompartmentRequest request)
Moves the specified private application from one compartment to another.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ChangePrivateApplicationCompartment API.
ChangeServiceCatalogCompartmentResponse changeServiceCatalogCompartment(ChangeServiceCatalogCompartmentRequest request)
Moves the specified service catalog from one compartment to another.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ChangeServiceCatalogCompartment API.
CreatePrivateApplicationResponse createPrivateApplication(CreatePrivateApplicationRequest request)
Creates a private application along with a single package to be hosted.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use CreatePrivateApplication API.
CreateServiceCatalogResponse createServiceCatalog(CreateServiceCatalogRequest request)
Creates a brand new service catalog in a given compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use CreateServiceCatalog API.
CreateServiceCatalogAssociationResponse createServiceCatalogAssociation(CreateServiceCatalogAssociationRequest request)
Creates an association between service catalog and a resource.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use CreateServiceCatalogAssociation API.
DeletePrivateApplicationResponse deletePrivateApplication(DeletePrivateApplicationRequest request)
Deletes an existing private application.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use DeletePrivateApplication API.
DeleteServiceCatalogResponse deleteServiceCatalog(DeleteServiceCatalogRequest request)
Deletes the specified service catalog from the compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use DeleteServiceCatalog API.
DeleteServiceCatalogAssociationResponse deleteServiceCatalogAssociation(DeleteServiceCatalogAssociationRequest request)
Removes an association between service catalog and a resource.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use DeleteServiceCatalogAssociation API.
GetPrivateApplicationResponse getPrivateApplication(GetPrivateApplicationRequest request)
Gets the details of the specified private application.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use GetPrivateApplication API.
GetPrivateApplicationActionDownloadLogoResponse getPrivateApplicationActionDownloadLogo(GetPrivateApplicationActionDownloadLogoRequest request)
Downloads the binary payload of the logo image of the private application.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use GetPrivateApplicationActionDownloadLogo API.
GetPrivateApplicationPackageResponse getPrivateApplicationPackage(GetPrivateApplicationPackageRequest request)
Gets the details of a specific package within a given private application.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use GetPrivateApplicationPackage API.
GetPrivateApplicationPackageActionDownloadConfigResponse getPrivateApplicationPackageActionDownloadConfig(GetPrivateApplicationPackageActionDownloadConfigRequest request)
Downloads the configuration that was used to create the private application package.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use GetPrivateApplicationPackageActionDownloadConfig API.
GetServiceCatalogResponse getServiceCatalog(GetServiceCatalogRequest request)
Gets detailed information about the service catalog including name, compartmentId
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use GetServiceCatalog API.
GetServiceCatalogAssociationResponse getServiceCatalogAssociation(GetServiceCatalogAssociationRequest request)
Gets detailed information about specific service catalog association.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use GetServiceCatalogAssociation API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use GetWorkRequest API.
ListApplicationsResponse listApplications(ListApplicationsRequest request)
Lists all the applications in a service catalog or a tenancy. If no parameter is specified, all catalogs from all compartments in the tenancy will be scanned for any type of content.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListApplications API.
ListPrivateApplicationPackagesResponse listPrivateApplicationPackages(ListPrivateApplicationPackagesRequest request)
Lists the packages in the specified private application.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListPrivateApplicationPackages API.
ListPrivateApplicationsResponse listPrivateApplications(ListPrivateApplicationsRequest request)
Lists all the private applications in a given compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListPrivateApplications API.
ListServiceCatalogAssociationsResponse listServiceCatalogAssociations(ListServiceCatalogAssociationsRequest request)
Lists all the resource associations for a specific service catalog.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListServiceCatalogAssociations API.
ListServiceCatalogsResponse listServiceCatalogs(ListServiceCatalogsRequest request)
Lists all the service catalogs in the given compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListServiceCatalogs API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use ListWorkRequests API.
UpdatePrivateApplicationResponse updatePrivateApplication(UpdatePrivateApplicationRequest request)
Updates the details of an existing private application.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use UpdatePrivateApplication API.
UpdateServiceCatalogResponse updateServiceCatalog(UpdateServiceCatalogRequest request)
Updates the details of a previously created service catalog.
request - The request object containing the details to sendBmcException - when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. 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 here to see how to use UpdateServiceCatalog API.
ServiceCatalogWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
ServiceCatalogPaginators 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.
Copyright © 2016–2023. All rights reserved.