com.oracle.bmc.licensemanager

Class LicenseManagerAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.licensemanager.LicenseManagerAsyncClient

All Implemented Interfaces:

LicenseManagerAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220430")
public class LicenseManagerAsyncClient
extends BaseAsyncClient
implements LicenseManagerAsync

Async client implementation for LicenseManager 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 and Description
static class	LicenseManagerAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 LicenseManager.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static LicenseManagerAsyncClient.Builder	builder() Create a builder for this client.
Future<BulkUploadLicenseRecordsResponse>	bulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest request, AsyncHandler<BulkUploadLicenseRecordsRequest,BulkUploadLicenseRecordsResponse> handler) Bulk upload the product licenses and license records for a given compartment.
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<CreateLicenseRecordResponse>	createLicenseRecord(CreateLicenseRecordRequest request, AsyncHandler<CreateLicenseRecordRequest,CreateLicenseRecordResponse> handler) Creates a new license record for the given product license ID.
Future<CreateProductLicenseResponse>	createProductLicense(CreateProductLicenseRequest request, AsyncHandler<CreateProductLicenseRequest,CreateProductLicenseResponse> handler) Creates a new product license.
Future<DeleteLicenseRecordResponse>	deleteLicenseRecord(DeleteLicenseRecordRequest request, AsyncHandler<DeleteLicenseRecordRequest,DeleteLicenseRecordResponse> handler) Removes a license record.
Future<DeleteProductLicenseResponse>	deleteProductLicense(DeleteProductLicenseRequest request, AsyncHandler<DeleteProductLicenseRequest,DeleteProductLicenseResponse> handler) Removes a product license.
Future<GetBulkUploadTemplateResponse>	getBulkUploadTemplate(GetBulkUploadTemplateRequest request, AsyncHandler<GetBulkUploadTemplateRequest,GetBulkUploadTemplateResponse> handler) Provides the bulk upload file template.
String	getClientCommonLibraryVersion()
Future<GetConfigurationResponse>	getConfiguration(GetConfigurationRequest request, AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler) Retrieves configuration for a compartment.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetLicenseMetricResponse>	getLicenseMetric(GetLicenseMetricRequest request, AsyncHandler<GetLicenseMetricRequest,GetLicenseMetricResponse> handler) Retrieves the license metrics for a given compartment.
Future<GetLicenseRecordResponse>	getLicenseRecord(GetLicenseRecordRequest request, AsyncHandler<GetLicenseRecordRequest,GetLicenseRecordResponse> handler) Retrieves license record details by the license record ID in a given compartment.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetProductLicenseResponse>	getProductLicense(GetProductLicenseRequest request, AsyncHandler<GetProductLicenseRequest,GetProductLicenseResponse> handler) Retrieves product license details by product license ID in a given compartment.
Future<ListLicenseRecordsResponse>	listLicenseRecords(ListLicenseRecordsRequest request, AsyncHandler<ListLicenseRecordsRequest,ListLicenseRecordsResponse> handler) Retrieves all license records for a given product license ID.
Future<ListProductLicenseConsumersResponse>	listProductLicenseConsumers(ListProductLicenseConsumersRequest request, AsyncHandler<ListProductLicenseConsumersRequest,ListProductLicenseConsumersResponse> handler) Retrieves the product license consumers for a particular product license ID.
Future<ListProductLicensesResponse>	listProductLicenses(ListProductLicensesRequest request, AsyncHandler<ListProductLicensesRequest,ListProductLicensesResponse> handler) Retrieves all the product licenses from a given compartment.
Future<ListTopUtilizedProductLicensesResponse>	listTopUtilizedProductLicenses(ListTopUtilizedProductLicensesRequest request, AsyncHandler<ListTopUtilizedProductLicensesRequest,ListTopUtilizedProductLicensesResponse> handler) Retrieves the top utilized product licenses for a given compartment.
Future<ListTopUtilizedResourcesResponse>	listTopUtilizedResources(ListTopUtilizedResourcesRequest request, AsyncHandler<ListTopUtilizedResourcesRequest,ListTopUtilizedResourcesResponse> handler) Retrieves the top utilized resources for a given 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<UpdateConfigurationResponse>	updateConfiguration(UpdateConfigurationRequest request, AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResponse> handler) Updates the configuration for the compartment.
Future<UpdateLicenseRecordResponse>	updateLicenseRecord(UpdateLicenseRecordRequest request, AsyncHandler<UpdateLicenseRecordRequest,UpdateLicenseRecordResponse> handler) Updates license record entity details.
Future<UpdateProductLicenseResponse>	updateProductLicense(UpdateProductLicenseRequest request, AsyncHandler<UpdateProductLicenseRequest,UpdateProductLicenseResponse> handler) Updates the list of images for a product license.
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 com.oracle.bmc.licensemanager.LicenseManagerAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for LicenseManager.

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

LicenseManagerAsyncClient

@Deprecated
public LicenseManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

LicenseManagerAsyncClient

@Deprecated
public LicenseManagerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

LicenseManagerAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

LicenseManagerAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LicenseManagerAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LicenseManagerAsyncClient

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

LicenseManagerAsyncClient

@Deprecated
public LicenseManagerAsyncClient(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 LicenseManagerAsyncClient.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 LicenseManagerAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: LicenseManagerAsync

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 LicenseManagerAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LicenseManagerAsync

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 LicenseManagerAsync

Parameters:

regionId - The public region ID.

bulkUploadLicenseRecords

public Future<BulkUploadLicenseRecordsResponse> bulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest request,
                                                                         AsyncHandler<BulkUploadLicenseRecordsRequest,BulkUploadLicenseRecordsResponse> handler)

Description copied from interface: LicenseManagerAsync

Bulk upload the product licenses and license records for a given compartment.

Specified by:

bulkUploadLicenseRecords in interface LicenseManagerAsync

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.

createLicenseRecord

public Future<CreateLicenseRecordResponse> createLicenseRecord(CreateLicenseRecordRequest request,
                                                               AsyncHandler<CreateLicenseRecordRequest,CreateLicenseRecordResponse> handler)

Description copied from interface: LicenseManagerAsync

Creates a new license record for the given product license ID.

Specified by:

createLicenseRecord in interface LicenseManagerAsync

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.

createProductLicense

public Future<CreateProductLicenseResponse> createProductLicense(CreateProductLicenseRequest request,
                                                                 AsyncHandler<CreateProductLicenseRequest,CreateProductLicenseResponse> handler)

Description copied from interface: LicenseManagerAsync

Creates a new product license.

Specified by:

createProductLicense in interface LicenseManagerAsync

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.

deleteLicenseRecord

public Future<DeleteLicenseRecordResponse> deleteLicenseRecord(DeleteLicenseRecordRequest request,
                                                               AsyncHandler<DeleteLicenseRecordRequest,DeleteLicenseRecordResponse> handler)

Description copied from interface: LicenseManagerAsync

Removes a license record.

Specified by:

deleteLicenseRecord in interface LicenseManagerAsync

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.

deleteProductLicense

public Future<DeleteProductLicenseResponse> deleteProductLicense(DeleteProductLicenseRequest request,
                                                                 AsyncHandler<DeleteProductLicenseRequest,DeleteProductLicenseResponse> handler)

Description copied from interface: LicenseManagerAsync

Removes a product license.

Specified by:

deleteProductLicense in interface LicenseManagerAsync

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.

getBulkUploadTemplate

public Future<GetBulkUploadTemplateResponse> getBulkUploadTemplate(GetBulkUploadTemplateRequest request,
                                                                   AsyncHandler<GetBulkUploadTemplateRequest,GetBulkUploadTemplateResponse> handler)

Description copied from interface: LicenseManagerAsync

Provides the bulk upload file template.

Specified by:

getBulkUploadTemplate in interface LicenseManagerAsync

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.

getConfiguration

public Future<GetConfigurationResponse> getConfiguration(GetConfigurationRequest request,
                                                         AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves configuration for a compartment.

Specified by:

getConfiguration in interface LicenseManagerAsync

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.

getLicenseMetric

public Future<GetLicenseMetricResponse> getLicenseMetric(GetLicenseMetricRequest request,
                                                         AsyncHandler<GetLicenseMetricRequest,GetLicenseMetricResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves the license metrics for a given compartment.

Specified by:

getLicenseMetric in interface LicenseManagerAsync

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.

getLicenseRecord

public Future<GetLicenseRecordResponse> getLicenseRecord(GetLicenseRecordRequest request,
                                                         AsyncHandler<GetLicenseRecordRequest,GetLicenseRecordResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves license record details by the license record ID in a given compartment.

Specified by:

getLicenseRecord in interface LicenseManagerAsync

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.

getProductLicense

public Future<GetProductLicenseResponse> getProductLicense(GetProductLicenseRequest request,
                                                           AsyncHandler<GetProductLicenseRequest,GetProductLicenseResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves product license details by product license ID in a given compartment.

Specified by:

getProductLicense in interface LicenseManagerAsync

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.

listLicenseRecords

public Future<ListLicenseRecordsResponse> listLicenseRecords(ListLicenseRecordsRequest request,
                                                             AsyncHandler<ListLicenseRecordsRequest,ListLicenseRecordsResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves all license records for a given product license ID.

Specified by:

listLicenseRecords in interface LicenseManagerAsync

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.

listProductLicenseConsumers

public Future<ListProductLicenseConsumersResponse> listProductLicenseConsumers(ListProductLicenseConsumersRequest request,
                                                                               AsyncHandler<ListProductLicenseConsumersRequest,ListProductLicenseConsumersResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves the product license consumers for a particular product license ID.

Specified by:

listProductLicenseConsumers in interface LicenseManagerAsync

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.

listProductLicenses

public Future<ListProductLicensesResponse> listProductLicenses(ListProductLicensesRequest request,
                                                               AsyncHandler<ListProductLicensesRequest,ListProductLicensesResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves all the product licenses from a given compartment.

Specified by:

listProductLicenses in interface LicenseManagerAsync

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.

listTopUtilizedProductLicenses

public Future<ListTopUtilizedProductLicensesResponse> listTopUtilizedProductLicenses(ListTopUtilizedProductLicensesRequest request,
                                                                                     AsyncHandler<ListTopUtilizedProductLicensesRequest,ListTopUtilizedProductLicensesResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves the top utilized product licenses for a given compartment.

Specified by:

listTopUtilizedProductLicenses in interface LicenseManagerAsync

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.

listTopUtilizedResources

public Future<ListTopUtilizedResourcesResponse> listTopUtilizedResources(ListTopUtilizedResourcesRequest request,
                                                                         AsyncHandler<ListTopUtilizedResourcesRequest,ListTopUtilizedResourcesResponse> handler)

Description copied from interface: LicenseManagerAsync

Retrieves the top utilized resources for a given compartment.

Specified by:

listTopUtilizedResources in interface LicenseManagerAsync

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.

updateConfiguration

public Future<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest request,
                                                               AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResponse> handler)

Description copied from interface: LicenseManagerAsync

Updates the configuration for the compartment.

Specified by:

updateConfiguration in interface LicenseManagerAsync

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.

updateLicenseRecord

public Future<UpdateLicenseRecordResponse> updateLicenseRecord(UpdateLicenseRecordRequest request,
                                                               AsyncHandler<UpdateLicenseRecordRequest,UpdateLicenseRecordResponse> handler)

Description copied from interface: LicenseManagerAsync

Updates license record entity details.

Specified by:

updateLicenseRecord in interface LicenseManagerAsync

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.

updateProductLicense

public Future<UpdateProductLicenseResponse> updateProductLicense(UpdateProductLicenseRequest request,
                                                                 AsyncHandler<UpdateProductLicenseRequest,UpdateProductLicenseResponse> handler)

Description copied from interface: LicenseManagerAsync

Updates the list of images for a product license.

Specified by:

updateProductLicense in interface LicenseManagerAsync

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)