Package com.oracle.bmc.servicecatalog

Class ServiceCatalogAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.servicecatalog.ServiceCatalogAsyncClient

All Implemented Interfaces:

ServiceCatalogAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210527")
public class ServiceCatalogAsyncClient
extends BaseAsyncClient
implements ServiceCatalogAsync

Async client implementation for ServiceCatalog service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceCatalogAsyncClient.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
ServiceCatalogAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
ServiceCatalogAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
ServiceCatalogAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ServiceCatalogAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ServiceCatalogAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
ServiceCatalogAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
ServiceCatalogAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static ServiceCatalogAsyncClient.Builder	builder()	Create a builder for this client.
Future<BulkReplaceServiceCatalogAssociationsResponse>	bulkReplaceServiceCatalogAssociations(BulkReplaceServiceCatalogAssociationsRequest request, AsyncHandler<BulkReplaceServiceCatalogAssociationsRequest,BulkReplaceServiceCatalogAssociationsResponse> handler)	Replace all associations of a given service catalog in one bulk transaction.
Future<ChangePrivateApplicationCompartmentResponse>	changePrivateApplicationCompartment(ChangePrivateApplicationCompartmentRequest request, AsyncHandler<ChangePrivateApplicationCompartmentRequest,ChangePrivateApplicationCompartmentResponse> handler)	Moves the specified private application from one compartment to another.
Future<ChangeServiceCatalogCompartmentResponse>	changeServiceCatalogCompartment(ChangeServiceCatalogCompartmentRequest request, AsyncHandler<ChangeServiceCatalogCompartmentRequest,ChangeServiceCatalogCompartmentResponse> handler)	Moves the specified service catalog from one compartment to another.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreatePrivateApplicationResponse>	createPrivateApplication(CreatePrivateApplicationRequest request, AsyncHandler<CreatePrivateApplicationRequest,CreatePrivateApplicationResponse> handler)	Creates a private application along with a single package to be hosted.
Future<CreateServiceCatalogResponse>	createServiceCatalog(CreateServiceCatalogRequest request, AsyncHandler<CreateServiceCatalogRequest,CreateServiceCatalogResponse> handler)	Creates a brand new service catalog in a given compartment.
Future<CreateServiceCatalogAssociationResponse>	createServiceCatalogAssociation(CreateServiceCatalogAssociationRequest request, AsyncHandler<CreateServiceCatalogAssociationRequest,CreateServiceCatalogAssociationResponse> handler)	Creates an association between service catalog and a resource.
Future<DeletePrivateApplicationResponse>	deletePrivateApplication(DeletePrivateApplicationRequest request, AsyncHandler<DeletePrivateApplicationRequest,DeletePrivateApplicationResponse> handler)	Deletes an existing private application.
Future<DeleteServiceCatalogResponse>	deleteServiceCatalog(DeleteServiceCatalogRequest request, AsyncHandler<DeleteServiceCatalogRequest,DeleteServiceCatalogResponse> handler)	Deletes the specified service catalog from the compartment.
Future<DeleteServiceCatalogAssociationResponse>	deleteServiceCatalogAssociation(DeleteServiceCatalogAssociationRequest request, AsyncHandler<DeleteServiceCatalogAssociationRequest,DeleteServiceCatalogAssociationResponse> handler)	Removes an association between service catalog and a resource.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetPrivateApplicationResponse>	getPrivateApplication(GetPrivateApplicationRequest request, AsyncHandler<GetPrivateApplicationRequest,GetPrivateApplicationResponse> handler)	Gets the details of the specified private application.
Future<GetPrivateApplicationActionDownloadLogoResponse>	getPrivateApplicationActionDownloadLogo(GetPrivateApplicationActionDownloadLogoRequest request, AsyncHandler<GetPrivateApplicationActionDownloadLogoRequest,GetPrivateApplicationActionDownloadLogoResponse> handler)	Downloads the binary payload of the logo image of the private application.
Future<GetPrivateApplicationPackageResponse>	getPrivateApplicationPackage(GetPrivateApplicationPackageRequest request, AsyncHandler<GetPrivateApplicationPackageRequest,GetPrivateApplicationPackageResponse> handler)	Gets the details of a specific package within a given private application.
Future<GetPrivateApplicationPackageActionDownloadConfigResponse>	getPrivateApplicationPackageActionDownloadConfig(GetPrivateApplicationPackageActionDownloadConfigRequest request, AsyncHandler<GetPrivateApplicationPackageActionDownloadConfigRequest,GetPrivateApplicationPackageActionDownloadConfigResponse> handler)	Downloads the configuration that was used to create the private application package.
Future<GetServiceCatalogResponse>	getServiceCatalog(GetServiceCatalogRequest request, AsyncHandler<GetServiceCatalogRequest,GetServiceCatalogResponse> handler)	Gets detailed information about the service catalog including name, compartmentId
Future<GetServiceCatalogAssociationResponse>	getServiceCatalogAssociation(GetServiceCatalogAssociationRequest request, AsyncHandler<GetServiceCatalogAssociationRequest,GetServiceCatalogAssociationResponse> handler)	Gets detailed information about specific service catalog association.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)	Gets the status of the work request with the given ID.
Future<ListApplicationsResponse>	listApplications(ListApplicationsRequest request, AsyncHandler<ListApplicationsRequest,ListApplicationsResponse> handler)	Lists all the applications in a service catalog or a tenancy.
Future<ListPrivateApplicationPackagesResponse>	listPrivateApplicationPackages(ListPrivateApplicationPackagesRequest request, AsyncHandler<ListPrivateApplicationPackagesRequest,ListPrivateApplicationPackagesResponse> handler)	Lists the packages in the specified private application.
Future<ListPrivateApplicationsResponse>	listPrivateApplications(ListPrivateApplicationsRequest request, AsyncHandler<ListPrivateApplicationsRequest,ListPrivateApplicationsResponse> handler)	Lists all the private applications in a given compartment.
Future<ListServiceCatalogAssociationsResponse>	listServiceCatalogAssociations(ListServiceCatalogAssociationsRequest request, AsyncHandler<ListServiceCatalogAssociationsRequest,ListServiceCatalogAssociationsResponse> handler)	Lists all the resource associations for a specific service catalog.
Future<ListServiceCatalogsResponse>	listServiceCatalogs(ListServiceCatalogsRequest request, AsyncHandler<ListServiceCatalogsRequest,ListServiceCatalogsResponse> handler)	Lists all the service catalogs in the given compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)	Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)	Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)	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.
Future<UpdatePrivateApplicationResponse>	updatePrivateApplication(UpdatePrivateApplicationRequest request, AsyncHandler<UpdatePrivateApplicationRequest,UpdatePrivateApplicationResponse> handler)	Updates the details of an existing private application.
Future<UpdateServiceCatalogResponse>	updateServiceCatalog(UpdateServiceCatalogRequest request, AsyncHandler<UpdateServiceCatalogRequest,UpdateServiceCatalogResponse> handler)	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 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.ServiceCatalogAsync

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

ServiceCatalogAsyncClient

@Deprecated
public ServiceCatalogAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ServiceCatalogAsyncClient

@Deprecated
public ServiceCatalogAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ServiceCatalogAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ServiceCatalogAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ServiceCatalogAsyncClient

@Deprecated
public ServiceCatalogAsyncClient(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 ServiceCatalogAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ServiceCatalogAsyncClient

@Deprecated
public ServiceCatalogAsyncClient(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 ServiceCatalogAsyncClient.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)

ServiceCatalogAsyncClient

@Deprecated
public ServiceCatalogAsyncClient(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 ServiceCatalogAsyncClient.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

Method Detail

builder

public static ServiceCatalogAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ServiceCatalogAsync

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 ServiceCatalogAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ServiceCatalogAsync

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 ServiceCatalogAsync

Parameters:

regionId - The public region ID.

bulkReplaceServiceCatalogAssociations

public Future<BulkReplaceServiceCatalogAssociationsResponse> bulkReplaceServiceCatalogAssociations(BulkReplaceServiceCatalogAssociationsRequest request,
                                                                                                   AsyncHandler<BulkReplaceServiceCatalogAssociationsRequest,BulkReplaceServiceCatalogAssociationsResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

bulkReplaceServiceCatalogAssociations in interface ServiceCatalogAsync

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.

changePrivateApplicationCompartment

public Future<ChangePrivateApplicationCompartmentResponse> changePrivateApplicationCompartment(ChangePrivateApplicationCompartmentRequest request,
                                                                                               AsyncHandler<ChangePrivateApplicationCompartmentRequest,ChangePrivateApplicationCompartmentResponse> handler)

Description copied from interface: ServiceCatalogAsync

Moves the specified private application from one compartment to another.

Specified by:

changePrivateApplicationCompartment in interface ServiceCatalogAsync

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.

changeServiceCatalogCompartment

public Future<ChangeServiceCatalogCompartmentResponse> changeServiceCatalogCompartment(ChangeServiceCatalogCompartmentRequest request,
                                                                                       AsyncHandler<ChangeServiceCatalogCompartmentRequest,ChangeServiceCatalogCompartmentResponse> handler)

Description copied from interface: ServiceCatalogAsync

Moves the specified service catalog from one compartment to another.

Specified by:

changeServiceCatalogCompartment in interface ServiceCatalogAsync

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.

createPrivateApplication

public Future<CreatePrivateApplicationResponse> createPrivateApplication(CreatePrivateApplicationRequest request,
                                                                         AsyncHandler<CreatePrivateApplicationRequest,CreatePrivateApplicationResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

createPrivateApplication in interface ServiceCatalogAsync

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.

createServiceCatalog

public Future<CreateServiceCatalogResponse> createServiceCatalog(CreateServiceCatalogRequest request,
                                                                 AsyncHandler<CreateServiceCatalogRequest,CreateServiceCatalogResponse> handler)

Description copied from interface: ServiceCatalogAsync

Creates a brand new service catalog in a given compartment.

Specified by:

createServiceCatalog in interface ServiceCatalogAsync

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.

createServiceCatalogAssociation

public Future<CreateServiceCatalogAssociationResponse> createServiceCatalogAssociation(CreateServiceCatalogAssociationRequest request,
                                                                                       AsyncHandler<CreateServiceCatalogAssociationRequest,CreateServiceCatalogAssociationResponse> handler)

Description copied from interface: ServiceCatalogAsync

Creates an association between service catalog and a resource.

Specified by:

createServiceCatalogAssociation in interface ServiceCatalogAsync

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.

deletePrivateApplication

public Future<DeletePrivateApplicationResponse> deletePrivateApplication(DeletePrivateApplicationRequest request,
                                                                         AsyncHandler<DeletePrivateApplicationRequest,DeletePrivateApplicationResponse> handler)

Description copied from interface: ServiceCatalogAsync

Deletes an existing private application.

Specified by:

deletePrivateApplication in interface ServiceCatalogAsync

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.

deleteServiceCatalog

public Future<DeleteServiceCatalogResponse> deleteServiceCatalog(DeleteServiceCatalogRequest request,
                                                                 AsyncHandler<DeleteServiceCatalogRequest,DeleteServiceCatalogResponse> handler)

Description copied from interface: ServiceCatalogAsync

Deletes the specified service catalog from the compartment.

Specified by:

deleteServiceCatalog in interface ServiceCatalogAsync

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.

deleteServiceCatalogAssociation

public Future<DeleteServiceCatalogAssociationResponse> deleteServiceCatalogAssociation(DeleteServiceCatalogAssociationRequest request,
                                                                                       AsyncHandler<DeleteServiceCatalogAssociationRequest,DeleteServiceCatalogAssociationResponse> handler)

Description copied from interface: ServiceCatalogAsync

Removes an association between service catalog and a resource.

Specified by:

deleteServiceCatalogAssociation in interface ServiceCatalogAsync

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.

getPrivateApplication

public Future<GetPrivateApplicationResponse> getPrivateApplication(GetPrivateApplicationRequest request,
                                                                   AsyncHandler<GetPrivateApplicationRequest,GetPrivateApplicationResponse> handler)

Description copied from interface: ServiceCatalogAsync

Gets the details of the specified private application.

Specified by:

getPrivateApplication in interface ServiceCatalogAsync

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.

getPrivateApplicationActionDownloadLogo

public Future<GetPrivateApplicationActionDownloadLogoResponse> getPrivateApplicationActionDownloadLogo(GetPrivateApplicationActionDownloadLogoRequest request,
                                                                                                       AsyncHandler<GetPrivateApplicationActionDownloadLogoRequest,GetPrivateApplicationActionDownloadLogoResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

getPrivateApplicationActionDownloadLogo in interface ServiceCatalogAsync

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.

getPrivateApplicationPackage

public Future<GetPrivateApplicationPackageResponse> getPrivateApplicationPackage(GetPrivateApplicationPackageRequest request,
                                                                                 AsyncHandler<GetPrivateApplicationPackageRequest,GetPrivateApplicationPackageResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

getPrivateApplicationPackage in interface ServiceCatalogAsync

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.

getPrivateApplicationPackageActionDownloadConfig

public Future<GetPrivateApplicationPackageActionDownloadConfigResponse> getPrivateApplicationPackageActionDownloadConfig(GetPrivateApplicationPackageActionDownloadConfigRequest request,
                                                                                                                         AsyncHandler<GetPrivateApplicationPackageActionDownloadConfigRequest,GetPrivateApplicationPackageActionDownloadConfigResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

getPrivateApplicationPackageActionDownloadConfig in interface ServiceCatalogAsync

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.

getServiceCatalog

public Future<GetServiceCatalogResponse> getServiceCatalog(GetServiceCatalogRequest request,
                                                           AsyncHandler<GetServiceCatalogRequest,GetServiceCatalogResponse> handler)

Description copied from interface: ServiceCatalogAsync

Gets detailed information about the service catalog including name, compartmentId

Specified by:

getServiceCatalog in interface ServiceCatalogAsync

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.

getServiceCatalogAssociation

public Future<GetServiceCatalogAssociationResponse> getServiceCatalogAssociation(GetServiceCatalogAssociationRequest request,
                                                                                 AsyncHandler<GetServiceCatalogAssociationRequest,GetServiceCatalogAssociationResponse> handler)

Description copied from interface: ServiceCatalogAsync

Gets detailed information about specific service catalog association.

Specified by:

getServiceCatalogAssociation in interface ServiceCatalogAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

getWorkRequest in interface ServiceCatalogAsync

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.

listApplications

public Future<ListApplicationsResponse> listApplications(ListApplicationsRequest request,
                                                         AsyncHandler<ListApplicationsRequest,ListApplicationsResponse> handler)

Description copied from interface: ServiceCatalogAsync

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 ServiceCatalogAsync

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.

listPrivateApplicationPackages

public Future<ListPrivateApplicationPackagesResponse> listPrivateApplicationPackages(ListPrivateApplicationPackagesRequest request,
                                                                                     AsyncHandler<ListPrivateApplicationPackagesRequest,ListPrivateApplicationPackagesResponse> handler)

Description copied from interface: ServiceCatalogAsync

Lists the packages in the specified private application.

Specified by:

listPrivateApplicationPackages in interface ServiceCatalogAsync

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.

listPrivateApplications

public Future<ListPrivateApplicationsResponse> listPrivateApplications(ListPrivateApplicationsRequest request,
                                                                       AsyncHandler<ListPrivateApplicationsRequest,ListPrivateApplicationsResponse> handler)

Description copied from interface: ServiceCatalogAsync

Lists all the private applications in a given compartment.

Specified by:

listPrivateApplications in interface ServiceCatalogAsync

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.

listServiceCatalogAssociations

public Future<ListServiceCatalogAssociationsResponse> listServiceCatalogAssociations(ListServiceCatalogAssociationsRequest request,
                                                                                     AsyncHandler<ListServiceCatalogAssociationsRequest,ListServiceCatalogAssociationsResponse> handler)

Description copied from interface: ServiceCatalogAsync

Lists all the resource associations for a specific service catalog.

Specified by:

listServiceCatalogAssociations in interface ServiceCatalogAsync

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.

listServiceCatalogs

public Future<ListServiceCatalogsResponse> listServiceCatalogs(ListServiceCatalogsRequest request,
                                                               AsyncHandler<ListServiceCatalogsRequest,ListServiceCatalogsResponse> handler)

Description copied from interface: ServiceCatalogAsync

Lists all the service catalogs in the given compartment.

Specified by:

listServiceCatalogs in interface ServiceCatalogAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

listWorkRequestErrors in interface ServiceCatalogAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: ServiceCatalogAsync

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

Specified by:

listWorkRequestLogs in interface ServiceCatalogAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: ServiceCatalogAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ServiceCatalogAsync

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.

updatePrivateApplication

public Future<UpdatePrivateApplicationResponse> updatePrivateApplication(UpdatePrivateApplicationRequest request,
                                                                         AsyncHandler<UpdatePrivateApplicationRequest,UpdatePrivateApplicationResponse> handler)

Description copied from interface: ServiceCatalogAsync

Updates the details of an existing private application.

Specified by:

updatePrivateApplication in interface ServiceCatalogAsync

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.

updateServiceCatalog

public Future<UpdateServiceCatalogResponse> updateServiceCatalog(UpdateServiceCatalogRequest request,
                                                                 AsyncHandler<UpdateServiceCatalogRequest,UpdateServiceCatalogResponse> handler)

Description copied from interface: ServiceCatalogAsync

Updates the details of a previously created service catalog.

Specified by:

updateServiceCatalog in interface ServiceCatalogAsync

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.

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()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)