LicenseManagerAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LicenseManagerAsyncClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220430")
public interface LicenseManagerAsync
extends AutoCloseable
```
Use the License Manager API to manage product licenses and license records. For more information, see License Manager Overview.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<BulkUploadLicenseRecordsResponse>`	`bulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest request, AsyncHandler<BulkUploadLicenseRecordsRequest,BulkUploadLicenseRecordsResponse> handler)` Bulk upload the product licenses and license records for a given compartment.
`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.
`Future<GetConfigurationResponse>`	`getConfiguration(GetConfigurationRequest request, AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler)` Retrieves configuration for a compartment.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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.
`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`	`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’).
`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 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 serice.
  - 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
```
Future<BulkUploadLicenseRecordsResponse> bulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest request,
                                                                  AsyncHandler<BulkUploadLicenseRecordsRequest,BulkUploadLicenseRecordsResponse> handler)
```
    Bulk upload the product licenses and license records for a given compartment.
    
    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
```
Future<CreateLicenseRecordResponse> createLicenseRecord(CreateLicenseRecordRequest request,
                                                        AsyncHandler<CreateLicenseRecordRequest,CreateLicenseRecordResponse> handler)
```
    Creates a new license record for the given product license ID.
    
    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
```
Future<CreateProductLicenseResponse> createProductLicense(CreateProductLicenseRequest request,
                                                          AsyncHandler<CreateProductLicenseRequest,CreateProductLicenseResponse> handler)
```
    Creates a new product license.
    
    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
```
Future<DeleteLicenseRecordResponse> deleteLicenseRecord(DeleteLicenseRecordRequest request,
                                                        AsyncHandler<DeleteLicenseRecordRequest,DeleteLicenseRecordResponse> handler)
```
    Removes a license record.
    
    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
```
Future<DeleteProductLicenseResponse> deleteProductLicense(DeleteProductLicenseRequest request,
                                                          AsyncHandler<DeleteProductLicenseRequest,DeleteProductLicenseResponse> handler)
```
    Removes a product license.
    
    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
```
Future<GetBulkUploadTemplateResponse> getBulkUploadTemplate(GetBulkUploadTemplateRequest request,
                                                            AsyncHandler<GetBulkUploadTemplateRequest,GetBulkUploadTemplateResponse> handler)
```
    Provides the bulk upload file template.
    
    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
```
Future<GetConfigurationResponse> getConfiguration(GetConfigurationRequest request,
                                                  AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler)
```
    Retrieves configuration for a compartment.
    
    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
```
Future<GetLicenseMetricResponse> getLicenseMetric(GetLicenseMetricRequest request,
                                                  AsyncHandler<GetLicenseMetricRequest,GetLicenseMetricResponse> handler)
```
    Retrieves the license metrics for a given compartment.
    
    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
```
Future<GetLicenseRecordResponse> getLicenseRecord(GetLicenseRecordRequest request,
                                                  AsyncHandler<GetLicenseRecordRequest,GetLicenseRecordResponse> handler)
```
    Retrieves license record details by the license record ID in a given compartment.
    
    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
```
Future<GetProductLicenseResponse> getProductLicense(GetProductLicenseRequest request,
                                                    AsyncHandler<GetProductLicenseRequest,GetProductLicenseResponse> handler)
```
    Retrieves product license details by product license ID in a given compartment.
    
    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
```
Future<ListLicenseRecordsResponse> listLicenseRecords(ListLicenseRecordsRequest request,
                                                      AsyncHandler<ListLicenseRecordsRequest,ListLicenseRecordsResponse> handler)
```
    Retrieves all license records for a given product license ID.
    
    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
```
Future<ListProductLicenseConsumersResponse> listProductLicenseConsumers(ListProductLicenseConsumersRequest request,
                                                                        AsyncHandler<ListProductLicenseConsumersRequest,ListProductLicenseConsumersResponse> handler)
```
    Retrieves the product license consumers for a particular product license ID.
    
    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
```
Future<ListProductLicensesResponse> listProductLicenses(ListProductLicensesRequest request,
                                                        AsyncHandler<ListProductLicensesRequest,ListProductLicensesResponse> handler)
```
    Retrieves all the product licenses from a given compartment.
    
    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
```
Future<ListTopUtilizedProductLicensesResponse> listTopUtilizedProductLicenses(ListTopUtilizedProductLicensesRequest request,
                                                                              AsyncHandler<ListTopUtilizedProductLicensesRequest,ListTopUtilizedProductLicensesResponse> handler)
```
    Retrieves the top utilized product licenses for a given compartment.
    
    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
```
Future<ListTopUtilizedResourcesResponse> listTopUtilizedResources(ListTopUtilizedResourcesRequest request,
                                                                  AsyncHandler<ListTopUtilizedResourcesRequest,ListTopUtilizedResourcesResponse> handler)
```
    Retrieves the top utilized resources for a given compartment.
    
    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
```
Future<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest request,
                                                        AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResponse> handler)
```
    Updates the configuration for the compartment.
    
    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
```
Future<UpdateLicenseRecordResponse> updateLicenseRecord(UpdateLicenseRecordRequest request,
                                                        AsyncHandler<UpdateLicenseRecordRequest,UpdateLicenseRecordResponse> handler)
```
    Updates license record entity details.
    
    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
```
Future<UpdateProductLicenseResponse> updateProductLicense(UpdateProductLicenseRequest request,
                                                          AsyncHandler<UpdateProductLicenseRequest,UpdateProductLicenseResponse> handler)
```
    Updates the list of images for a product license.
    
    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.

Interface LicenseManagerAsync

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