com.oracle.bmc.licensemanager

Class LicenseManagerClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.licensemanager.LicenseManagerClient

All Implemented Interfaces:

LicenseManager, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220430")
public class LicenseManagerClient
extends BaseSyncClient
implements LicenseManager

Nested Class Summary

Nested Classes

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

Method Summary

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

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

LicenseManagerClient

@Deprecated
public LicenseManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

LicenseManagerClient

@Deprecated
public LicenseManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

LicenseManagerClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

LicenseManagerClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LicenseManagerClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LicenseManagerClient

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

LicenseManagerClient

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

LicenseManagerClient

@Deprecated
public LicenseManagerClient(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 LicenseManagerClient.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 - LicenseManagerClient.Builder.executorService

Method Detail

builder

public static LicenseManagerClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: LicenseManager

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 LicenseManager

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LicenseManager

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 LicenseManager

Parameters:

regionId - The public region ID.

bulkUploadLicenseRecords

public BulkUploadLicenseRecordsResponse bulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest request)

Description copied from interface: LicenseManager

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

Specified by:

bulkUploadLicenseRecords in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createLicenseRecord

public CreateLicenseRecordResponse createLicenseRecord(CreateLicenseRecordRequest request)

Description copied from interface: LicenseManager

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

Specified by:

createLicenseRecord in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createProductLicense

public CreateProductLicenseResponse createProductLicense(CreateProductLicenseRequest request)

Description copied from interface: LicenseManager

Creates a new product license.

Specified by:

createProductLicense in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteLicenseRecord

public DeleteLicenseRecordResponse deleteLicenseRecord(DeleteLicenseRecordRequest request)

Description copied from interface: LicenseManager

Removes a license record.

Specified by:

deleteLicenseRecord in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteProductLicense

public DeleteProductLicenseResponse deleteProductLicense(DeleteProductLicenseRequest request)

Description copied from interface: LicenseManager

Removes a product license.

Specified by:

deleteProductLicense in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBulkUploadTemplate

public GetBulkUploadTemplateResponse getBulkUploadTemplate(GetBulkUploadTemplateRequest request)

Description copied from interface: LicenseManager

Provides the bulk upload file template.

Specified by:

getBulkUploadTemplate in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getConfiguration

public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)

Description copied from interface: LicenseManager

Retrieves configuration for a compartment.

Specified by:

getConfiguration in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getLicenseMetric

public GetLicenseMetricResponse getLicenseMetric(GetLicenseMetricRequest request)

Description copied from interface: LicenseManager

Retrieves the license metrics for a given compartment.

Specified by:

getLicenseMetric in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getLicenseRecord

public GetLicenseRecordResponse getLicenseRecord(GetLicenseRecordRequest request)

Description copied from interface: LicenseManager

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

Specified by:

getLicenseRecord in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getProductLicense

public GetProductLicenseResponse getProductLicense(GetProductLicenseRequest request)

Description copied from interface: LicenseManager

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

Specified by:

getProductLicense in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listLicenseRecords

public ListLicenseRecordsResponse listLicenseRecords(ListLicenseRecordsRequest request)

Description copied from interface: LicenseManager

Retrieves all license records for a given product license ID.

Specified by:

listLicenseRecords in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProductLicenseConsumers

public ListProductLicenseConsumersResponse listProductLicenseConsumers(ListProductLicenseConsumersRequest request)

Description copied from interface: LicenseManager

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

Specified by:

listProductLicenseConsumers in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProductLicenses

public ListProductLicensesResponse listProductLicenses(ListProductLicensesRequest request)

Description copied from interface: LicenseManager

Retrieves all the product licenses from a given compartment.

Specified by:

listProductLicenses in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTopUtilizedProductLicenses

public ListTopUtilizedProductLicensesResponse listTopUtilizedProductLicenses(ListTopUtilizedProductLicensesRequest request)

Description copied from interface: LicenseManager

Retrieves the top utilized product licenses for a given compartment.

Specified by:

listTopUtilizedProductLicenses in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTopUtilizedResources

public ListTopUtilizedResourcesResponse listTopUtilizedResources(ListTopUtilizedResourcesRequest request)

Description copied from interface: LicenseManager

Retrieves the top utilized resources for a given compartment.

Specified by:

listTopUtilizedResources in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateConfiguration

public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)

Description copied from interface: LicenseManager

Updates the configuration for the compartment.

Specified by:

updateConfiguration in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateLicenseRecord

public UpdateLicenseRecordResponse updateLicenseRecord(UpdateLicenseRecordRequest request)

Description copied from interface: LicenseManager

Updates license record entity details.

Specified by:

updateLicenseRecord in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateProductLicense

public UpdateProductLicenseResponse updateProductLicense(UpdateProductLicenseRequest request)

Description copied from interface: LicenseManager

Updates the list of images for a product license.

Specified by:

updateProductLicense in interface LicenseManager

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public LicenseManagerWaiters getWaiters()

Description copied from interface: LicenseManager

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

Specified by:

getWaiters in interface LicenseManager

Returns:

The service waiters.

getPaginators

public LicenseManagerPaginators getPaginators()

Description copied from interface: LicenseManager

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 LicenseManager

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