LicenseManager (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LicenseManagerClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220430")
public interface LicenseManager
extends AutoCloseable
```
Use the License Manager API to manage product licenses and license records. For more information, see License Manager Overview. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BulkUploadLicenseRecordsResponse`	`bulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest request)` Bulk upload the product licenses and license records for a given compartment.
`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.
`GetConfigurationResponse`	`getConfiguration(GetConfigurationRequest request)` Retrieves configuration for a compartment.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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.
`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`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`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’).
`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 realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - bulkUploadLicenseRecords
```
BulkUploadLicenseRecordsResponse bulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest request)
```
    Bulk upload the product licenses and license records for a given compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use BulkUploadLicenseRecords API.
  - createLicenseRecord
```
CreateLicenseRecordResponse createLicenseRecord(CreateLicenseRecordRequest request)
```
    Creates a new license record for the given product license ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateLicenseRecord API.
  - createProductLicense
```
CreateProductLicenseResponse createProductLicense(CreateProductLicenseRequest request)
```
    Creates a new product license.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateProductLicense API.
  - deleteLicenseRecord
```
DeleteLicenseRecordResponse deleteLicenseRecord(DeleteLicenseRecordRequest request)
```
    Removes a license record.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteLicenseRecord API.
  - deleteProductLicense
```
DeleteProductLicenseResponse deleteProductLicense(DeleteProductLicenseRequest request)
```
    Removes a product license.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteProductLicense API.
  - getBulkUploadTemplate
```
GetBulkUploadTemplateResponse getBulkUploadTemplate(GetBulkUploadTemplateRequest request)
```
    Provides the bulk upload file template.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetBulkUploadTemplate API.
  - getConfiguration
```
GetConfigurationResponse getConfiguration(GetConfigurationRequest request)
```
    Retrieves configuration for a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetConfiguration API.
  - getLicenseMetric
```
GetLicenseMetricResponse getLicenseMetric(GetLicenseMetricRequest request)
```
    Retrieves the license metrics for a given compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetLicenseMetric API.
  - getLicenseRecord
```
GetLicenseRecordResponse getLicenseRecord(GetLicenseRecordRequest request)
```
    Retrieves license record details by the license record ID in a given compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetLicenseRecord API.
  - getProductLicense
```
GetProductLicenseResponse getProductLicense(GetProductLicenseRequest request)
```
    Retrieves product license details by product license ID in a given compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetProductLicense API.
  - listLicenseRecords
```
ListLicenseRecordsResponse listLicenseRecords(ListLicenseRecordsRequest request)
```
    Retrieves all license records for a given product license ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListLicenseRecords API.
  - listProductLicenseConsumers
```
ListProductLicenseConsumersResponse listProductLicenseConsumers(ListProductLicenseConsumersRequest request)
```
    Retrieves the product license consumers for a particular product license ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListProductLicenseConsumers API.
  - listProductLicenses
```
ListProductLicensesResponse listProductLicenses(ListProductLicensesRequest request)
```
    Retrieves all the product licenses from a given compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListProductLicenses API.
  - listTopUtilizedProductLicenses
```
ListTopUtilizedProductLicensesResponse listTopUtilizedProductLicenses(ListTopUtilizedProductLicensesRequest request)
```
    Retrieves the top utilized product licenses for a given compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListTopUtilizedProductLicenses API.
  - listTopUtilizedResources
```
ListTopUtilizedResourcesResponse listTopUtilizedResources(ListTopUtilizedResourcesRequest request)
```
    Retrieves the top utilized resources for a given compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListTopUtilizedResources API.
  - updateConfiguration
```
UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)
```
    Updates the configuration for the compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateConfiguration API.
  - updateLicenseRecord
```
UpdateLicenseRecordResponse updateLicenseRecord(UpdateLicenseRecordRequest request)
```
    Updates license record entity details.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateLicenseRecord API.
  - updateProductLicense
```
UpdateProductLicenseResponse updateProductLicense(UpdateProductLicenseRequest request)
```
    Updates the list of images for a product license.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateProductLicense API.
  - getWaiters
```
LicenseManagerWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
LicenseManagerPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface LicenseManager

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

bulkUploadLicenseRecords

createLicenseRecord

createProductLicense

deleteLicenseRecord

deleteProductLicense

getBulkUploadTemplate

getConfiguration

getLicenseMetric

getLicenseRecord

getProductLicense

listLicenseRecords

listProductLicenseConsumers

listProductLicenses

listTopUtilizedProductLicenses

listTopUtilizedResources

updateConfiguration

updateLicenseRecord

updateProductLicense

getWaiters

getPaginators