Package com.oracle.bmc.servicecatalog

Class ServiceCatalogClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.servicecatalog.ServiceCatalogClient

All Implemented Interfaces:

ServiceCatalog, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210527")
public class ServiceCatalogClient
extends BaseSyncClient
implements ServiceCatalog

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceCatalogClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for ServiceCatalog.

Constructor Summary

Constructors

Constructor	Description
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static ServiceCatalogClient.Builder	builder()	Create a builder for this client.
BulkReplaceServiceCatalogAssociationsResponse	bulkReplaceServiceCatalogAssociations(BulkReplaceServiceCatalogAssociationsRequest request)	Replace all associations of a given service catalog in one bulk transaction.
ChangePrivateApplicationCompartmentResponse	changePrivateApplicationCompartment(ChangePrivateApplicationCompartmentRequest request)	Moves the specified private application from one compartment to another.
ChangeServiceCatalogCompartmentResponse	changeServiceCatalogCompartment(ChangeServiceCatalogCompartmentRequest request)	Moves the specified service catalog from one compartment to another.
void	close()
CreatePrivateApplicationResponse	createPrivateApplication(CreatePrivateApplicationRequest request)	Creates a private application along with a single package to be hosted.
CreateServiceCatalogResponse	createServiceCatalog(CreateServiceCatalogRequest request)	Creates a brand new service catalog in a given compartment.
CreateServiceCatalogAssociationResponse	createServiceCatalogAssociation(CreateServiceCatalogAssociationRequest request)	Creates an association between service catalog and a resource.
DeletePrivateApplicationResponse	deletePrivateApplication(DeletePrivateApplicationRequest request)	Deletes an existing private application.
DeleteServiceCatalogResponse	deleteServiceCatalog(DeleteServiceCatalogRequest request)	Deletes the specified service catalog from the compartment.
DeleteServiceCatalogAssociationResponse	deleteServiceCatalogAssociation(DeleteServiceCatalogAssociationRequest request)	Removes an association between service catalog and a resource.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ServiceCatalogPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPrivateApplicationResponse	getPrivateApplication(GetPrivateApplicationRequest request)	Gets the details of the specified private application.
GetPrivateApplicationActionDownloadLogoResponse	getPrivateApplicationActionDownloadLogo(GetPrivateApplicationActionDownloadLogoRequest request)	Downloads the binary payload of the logo image of the private application.
GetPrivateApplicationPackageResponse	getPrivateApplicationPackage(GetPrivateApplicationPackageRequest request)	Gets the details of a specific package within a given private application.
GetPrivateApplicationPackageActionDownloadConfigResponse	getPrivateApplicationPackageActionDownloadConfig(GetPrivateApplicationPackageActionDownloadConfigRequest request)	Downloads the configuration that was used to create the private application package.
GetServiceCatalogResponse	getServiceCatalog(GetServiceCatalogRequest request)	Gets detailed information about the service catalog including name, compartmentId
GetServiceCatalogAssociationResponse	getServiceCatalogAssociation(GetServiceCatalogAssociationRequest request)	Gets detailed information about specific service catalog association.
ServiceCatalogWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the status of the work request with the given ID.
ListApplicationsResponse	listApplications(ListApplicationsRequest request)	Lists all the applications in a service catalog or a tenancy.
ListPrivateApplicationPackagesResponse	listPrivateApplicationPackages(ListPrivateApplicationPackagesRequest request)	Lists the packages in the specified private application.
ListPrivateApplicationsResponse	listPrivateApplications(ListPrivateApplicationsRequest request)	Lists all the private applications in a given compartment.
ListServiceCatalogAssociationsResponse	listServiceCatalogAssociations(ListServiceCatalogAssociationsRequest request)	Lists all the resource associations for a specific service catalog.
ListServiceCatalogsResponse	listServiceCatalogs(ListServiceCatalogsRequest request)	Lists all the service catalogs in the given compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Return a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdatePrivateApplicationResponse	updatePrivateApplication(UpdatePrivateApplicationRequest request)	Updates the details of an existing private application.
UpdateServiceCatalogResponse	updateServiceCatalog(UpdateServiceCatalogRequest request)	Updates the details of a previously created service catalog.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.servicecatalog.ServiceCatalog

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ServiceCatalog.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

ServiceCatalogClient

@Deprecated
public ServiceCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint,
                            ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - ServiceCatalogClient.Builder.executorService

Method Detail

builder

public static ServiceCatalogClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ServiceCatalog

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.

Specified by:

setRegion in interface ServiceCatalog

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ServiceCatalog

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.

Specified by:

setRegion in interface ServiceCatalog

Parameters:

regionId - The public region ID.

bulkReplaceServiceCatalogAssociations

public BulkReplaceServiceCatalogAssociationsResponse bulkReplaceServiceCatalogAssociations(BulkReplaceServiceCatalogAssociationsRequest request)

Description copied from interface: ServiceCatalog

Replace all associations of a given service catalog in one bulk transaction.

Specified by:

bulkReplaceServiceCatalogAssociations in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changePrivateApplicationCompartment

public ChangePrivateApplicationCompartmentResponse changePrivateApplicationCompartment(ChangePrivateApplicationCompartmentRequest request)

Description copied from interface: ServiceCatalog

Moves the specified private application from one compartment to another.

Specified by:

changePrivateApplicationCompartment in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeServiceCatalogCompartment

public ChangeServiceCatalogCompartmentResponse changeServiceCatalogCompartment(ChangeServiceCatalogCompartmentRequest request)

Description copied from interface: ServiceCatalog

Moves the specified service catalog from one compartment to another.

Specified by:

changeServiceCatalogCompartment in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPrivateApplication

public CreatePrivateApplicationResponse createPrivateApplication(CreatePrivateApplicationRequest request)

Description copied from interface: ServiceCatalog

Creates a private application along with a single package to be hosted.

Specified by:

createPrivateApplication in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createServiceCatalog

public CreateServiceCatalogResponse createServiceCatalog(CreateServiceCatalogRequest request)

Description copied from interface: ServiceCatalog

Creates a brand new service catalog in a given compartment.

Specified by:

createServiceCatalog in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createServiceCatalogAssociation

public CreateServiceCatalogAssociationResponse createServiceCatalogAssociation(CreateServiceCatalogAssociationRequest request)

Description copied from interface: ServiceCatalog

Creates an association between service catalog and a resource.

Specified by:

createServiceCatalogAssociation in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePrivateApplication

public DeletePrivateApplicationResponse deletePrivateApplication(DeletePrivateApplicationRequest request)

Description copied from interface: ServiceCatalog

Deletes an existing private application.

Specified by:

deletePrivateApplication in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteServiceCatalog

public DeleteServiceCatalogResponse deleteServiceCatalog(DeleteServiceCatalogRequest request)

Description copied from interface: ServiceCatalog

Deletes the specified service catalog from the compartment.

Specified by:

deleteServiceCatalog in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteServiceCatalogAssociation

public DeleteServiceCatalogAssociationResponse deleteServiceCatalogAssociation(DeleteServiceCatalogAssociationRequest request)

Description copied from interface: ServiceCatalog

Removes an association between service catalog and a resource.

Specified by:

deleteServiceCatalogAssociation in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivateApplication

public GetPrivateApplicationResponse getPrivateApplication(GetPrivateApplicationRequest request)

Description copied from interface: ServiceCatalog

Gets the details of the specified private application.

Specified by:

getPrivateApplication in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivateApplicationActionDownloadLogo

public GetPrivateApplicationActionDownloadLogoResponse getPrivateApplicationActionDownloadLogo(GetPrivateApplicationActionDownloadLogoRequest request)

Description copied from interface: ServiceCatalog

Downloads the binary payload of the logo image of the private application.

Specified by:

getPrivateApplicationActionDownloadLogo in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivateApplicationPackage

public GetPrivateApplicationPackageResponse getPrivateApplicationPackage(GetPrivateApplicationPackageRequest request)

Description copied from interface: ServiceCatalog

Gets the details of a specific package within a given private application.

Specified by:

getPrivateApplicationPackage in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivateApplicationPackageActionDownloadConfig

public GetPrivateApplicationPackageActionDownloadConfigResponse getPrivateApplicationPackageActionDownloadConfig(GetPrivateApplicationPackageActionDownloadConfigRequest request)

Description copied from interface: ServiceCatalog

Downloads the configuration that was used to create the private application package.

Specified by:

getPrivateApplicationPackageActionDownloadConfig in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getServiceCatalog

public GetServiceCatalogResponse getServiceCatalog(GetServiceCatalogRequest request)

Description copied from interface: ServiceCatalog

Gets detailed information about the service catalog including name, compartmentId

Specified by:

getServiceCatalog in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getServiceCatalogAssociation

public GetServiceCatalogAssociationResponse getServiceCatalogAssociation(GetServiceCatalogAssociationRequest request)

Description copied from interface: ServiceCatalog

Gets detailed information about specific service catalog association.

Specified by:

getServiceCatalogAssociation in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: ServiceCatalog

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApplications

public ListApplicationsResponse listApplications(ListApplicationsRequest request)

Description copied from interface: ServiceCatalog

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.

Specified by:

listApplications in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPrivateApplicationPackages

public ListPrivateApplicationPackagesResponse listPrivateApplicationPackages(ListPrivateApplicationPackagesRequest request)

Description copied from interface: ServiceCatalog

Lists the packages in the specified private application.

Specified by:

listPrivateApplicationPackages in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPrivateApplications

public ListPrivateApplicationsResponse listPrivateApplications(ListPrivateApplicationsRequest request)

Description copied from interface: ServiceCatalog

Lists all the private applications in a given compartment.

Specified by:

listPrivateApplications in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listServiceCatalogAssociations

public ListServiceCatalogAssociationsResponse listServiceCatalogAssociations(ListServiceCatalogAssociationsRequest request)

Description copied from interface: ServiceCatalog

Lists all the resource associations for a specific service catalog.

Specified by:

listServiceCatalogAssociations in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listServiceCatalogs

public ListServiceCatalogsResponse listServiceCatalogs(ListServiceCatalogsRequest request)

Description copied from interface: ServiceCatalog

Lists all the service catalogs in the given compartment.

Specified by:

listServiceCatalogs in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: ServiceCatalog

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: ServiceCatalog

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: ServiceCatalog

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePrivateApplication

public UpdatePrivateApplicationResponse updatePrivateApplication(UpdatePrivateApplicationRequest request)

Description copied from interface: ServiceCatalog

Updates the details of an existing private application.

Specified by:

updatePrivateApplication in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateServiceCatalog

public UpdateServiceCatalogResponse updateServiceCatalog(UpdateServiceCatalogRequest request)

Description copied from interface: ServiceCatalog

Updates the details of a previously created service catalog.

Specified by:

updateServiceCatalog in interface ServiceCatalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ServiceCatalogWaiters getWaiters()

Description copied from interface: ServiceCatalog

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface ServiceCatalog

Returns:

The service waiters.

getPaginators

public ServiceCatalogPaginators getPaginators()

Description copied from interface: ServiceCatalog

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.

Specified by:

getPaginators in interface ServiceCatalog

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()