Package com.oracle.bmc.cloudbridge

Class InventoryAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.cloudbridge.InventoryAsyncClient

All Implemented Interfaces:

InventoryAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220509")
public class InventoryAsyncClient
extends BaseAsyncClient
implements InventoryAsync

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InventoryAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Inventory.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Future<AnalyzeAssetsResponse>	analyzeAssets(AnalyzeAssetsRequest request, AsyncHandler<AnalyzeAssetsRequest,AnalyzeAssetsResponse> handler)	Returns an aggregation of assets.
static InventoryAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeAssetCompartmentResponse>	changeAssetCompartment(ChangeAssetCompartmentRequest request, AsyncHandler<ChangeAssetCompartmentRequest,ChangeAssetCompartmentResponse> handler)	Moves an asset resource from one compartment to another.
Future<ChangeAssetTagsResponse>	changeAssetTags(ChangeAssetTagsRequest request, AsyncHandler<ChangeAssetTagsRequest,ChangeAssetTagsResponse> handler)	Change an asset’s tag.
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<CreateAssetResponse>	createAsset(CreateAssetRequest request, AsyncHandler<CreateAssetRequest,CreateAssetResponse> handler)	Creates an asset.
Future<CreateInventoryResponse>	createInventory(CreateInventoryRequest request, AsyncHandler<CreateInventoryRequest,CreateInventoryResponse> handler)	Creates an inventory.
Future<DeleteAssetResponse>	deleteAsset(DeleteAssetRequest request, AsyncHandler<DeleteAssetRequest,DeleteAssetResponse> handler)	Deletes an asset resource by identifier.
Future<DeleteInventoryResponse>	deleteInventory(DeleteInventoryRequest request, AsyncHandler<DeleteInventoryRequest,DeleteInventoryResponse> handler)	Deletes an inventory resource by identifier.
Future<GetAssetResponse>	getAsset(GetAssetRequest request, AsyncHandler<GetAssetRequest,GetAssetResponse> handler)	Gets an asset by identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetInventoryResponse>	getInventory(GetInventoryRequest request, AsyncHandler<GetInventoryRequest,GetInventoryResponse> handler)	Gets an inventory by identifier.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ImportInventoryResponse>	importInventory(ImportInventoryRequest request, AsyncHandler<ImportInventoryRequest,ImportInventoryResponse> handler)	Import resources in inventory.
Future<ListAssetsResponse>	listAssets(ListAssetsRequest request, AsyncHandler<ListAssetsRequest,ListAssetsResponse> handler)	Returns a list of assets.
Future<ListHistoricalMetricsResponse>	listHistoricalMetrics(ListHistoricalMetricsRequest request, AsyncHandler<ListHistoricalMetricsRequest,ListHistoricalMetricsResponse> handler)	List asset historical metrics.
Future<ListInventoriesResponse>	listInventories(ListInventoriesRequest request, AsyncHandler<ListInventoriesRequest,ListInventoriesResponse> handler)	Returns a list of inventories.
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’).
Future<SubmitHistoricalMetricsResponse>	submitHistoricalMetrics(SubmitHistoricalMetricsRequest request, AsyncHandler<SubmitHistoricalMetricsRequest,SubmitHistoricalMetricsResponse> handler)	Creates or updates all metrics related to the asset.
Future<UpdateAssetResponse>	updateAsset(UpdateAssetRequest request, AsyncHandler<UpdateAssetRequest,UpdateAssetResponse> handler)	Updates the asset.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateInventoryResponse>	updateInventory(UpdateInventoryRequest request, AsyncHandler<UpdateInventoryRequest,UpdateInventoryResponse> handler)	Updates an inventory.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.cloudbridge.InventoryAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Inventory.

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

InventoryAsyncClient

@Deprecated
public InventoryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

InventoryAsyncClient

@Deprecated
public InventoryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

InventoryAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

InventoryAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

InventoryAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

InventoryAsyncClient

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

InventoryAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: InventoryAsync

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 InventoryAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: InventoryAsync

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 InventoryAsync

Parameters:

regionId - The public region ID.

analyzeAssets

public Future<AnalyzeAssetsResponse> analyzeAssets(AnalyzeAssetsRequest request,
                                                   AsyncHandler<AnalyzeAssetsRequest,AnalyzeAssetsResponse> handler)

Description copied from interface: InventoryAsync

Returns an aggregation of assets.

Aggregation groups are sorted by groupBy property. Default sort order is ascending, but can be overridden by the sortOrder parameter.

Specified by:

analyzeAssets in interface InventoryAsync

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.

changeAssetCompartment

public Future<ChangeAssetCompartmentResponse> changeAssetCompartment(ChangeAssetCompartmentRequest request,
                                                                     AsyncHandler<ChangeAssetCompartmentRequest,ChangeAssetCompartmentResponse> handler)

Description copied from interface: InventoryAsync

Moves an asset resource from one compartment to another.

When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeAssetCompartment in interface InventoryAsync

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.

changeAssetTags

public Future<ChangeAssetTagsResponse> changeAssetTags(ChangeAssetTagsRequest request,
                                                       AsyncHandler<ChangeAssetTagsRequest,ChangeAssetTagsResponse> handler)

Description copied from interface: InventoryAsync

Change an asset’s tag.

Specified by:

changeAssetTags in interface InventoryAsync

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.

createAsset

public Future<CreateAssetResponse> createAsset(CreateAssetRequest request,
                                               AsyncHandler<CreateAssetRequest,CreateAssetResponse> handler)

Description copied from interface: InventoryAsync

Creates an asset.

Specified by:

createAsset in interface InventoryAsync

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.

createInventory

public Future<CreateInventoryResponse> createInventory(CreateInventoryRequest request,
                                                       AsyncHandler<CreateInventoryRequest,CreateInventoryResponse> handler)

Description copied from interface: InventoryAsync

Creates an inventory.

Specified by:

createInventory in interface InventoryAsync

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.

deleteAsset

public Future<DeleteAssetResponse> deleteAsset(DeleteAssetRequest request,
                                               AsyncHandler<DeleteAssetRequest,DeleteAssetResponse> handler)

Description copied from interface: InventoryAsync

Deletes an asset resource by identifier.

Specified by:

deleteAsset in interface InventoryAsync

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.

deleteInventory

public Future<DeleteInventoryResponse> deleteInventory(DeleteInventoryRequest request,
                                                       AsyncHandler<DeleteInventoryRequest,DeleteInventoryResponse> handler)

Description copied from interface: InventoryAsync

Deletes an inventory resource by identifier.

Specified by:

deleteInventory in interface InventoryAsync

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.

getAsset

public Future<GetAssetResponse> getAsset(GetAssetRequest request,
                                         AsyncHandler<GetAssetRequest,GetAssetResponse> handler)

Description copied from interface: InventoryAsync

Gets an asset by identifier.

Specified by:

getAsset in interface InventoryAsync

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.

getInventory

public Future<GetInventoryResponse> getInventory(GetInventoryRequest request,
                                                 AsyncHandler<GetInventoryRequest,GetInventoryResponse> handler)

Description copied from interface: InventoryAsync

Gets an inventory by identifier.

Specified by:

getInventory in interface InventoryAsync

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.

importInventory

public Future<ImportInventoryResponse> importInventory(ImportInventoryRequest request,
                                                       AsyncHandler<ImportInventoryRequest,ImportInventoryResponse> handler)

Description copied from interface: InventoryAsync

Import resources in inventory.

Specified by:

importInventory in interface InventoryAsync

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.

listAssets

public Future<ListAssetsResponse> listAssets(ListAssetsRequest request,
                                             AsyncHandler<ListAssetsRequest,ListAssetsResponse> handler)

Description copied from interface: InventoryAsync

Returns a list of assets.

Specified by:

listAssets in interface InventoryAsync

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.

listHistoricalMetrics

public Future<ListHistoricalMetricsResponse> listHistoricalMetrics(ListHistoricalMetricsRequest request,
                                                                   AsyncHandler<ListHistoricalMetricsRequest,ListHistoricalMetricsResponse> handler)

Description copied from interface: InventoryAsync

List asset historical metrics.

Specified by:

listHistoricalMetrics in interface InventoryAsync

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.

listInventories

public Future<ListInventoriesResponse> listInventories(ListInventoriesRequest request,
                                                       AsyncHandler<ListInventoriesRequest,ListInventoriesResponse> handler)

Description copied from interface: InventoryAsync

Returns a list of inventories.

Specified by:

listInventories in interface InventoryAsync

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.

submitHistoricalMetrics

public Future<SubmitHistoricalMetricsResponse> submitHistoricalMetrics(SubmitHistoricalMetricsRequest request,
                                                                       AsyncHandler<SubmitHistoricalMetricsRequest,SubmitHistoricalMetricsResponse> handler)

Description copied from interface: InventoryAsync

Creates or updates all metrics related to the asset.

Specified by:

submitHistoricalMetrics in interface InventoryAsync

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.

updateAsset

public Future<UpdateAssetResponse> updateAsset(UpdateAssetRequest request,
                                               AsyncHandler<UpdateAssetRequest,UpdateAssetResponse> handler)

Description copied from interface: InventoryAsync

Updates the asset.

Specified by:

updateAsset in interface InventoryAsync

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.

updateInventory

public Future<UpdateInventoryResponse> updateInventory(UpdateInventoryRequest request,
                                                       AsyncHandler<UpdateInventoryRequest,UpdateInventoryResponse> handler)

Description copied from interface: InventoryAsync

Updates an inventory.

Specified by:

updateInventory in interface InventoryAsync

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)