Class OracleDbAzureVaultAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.dbmulticloud.OracleDbAzureVaultAsyncClient
-
- All Implemented Interfaces:
OracleDbAzureVaultAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20240501") public class OracleDbAzureVaultAsyncClient extends BaseAsyncClient implements OracleDbAzureVaultAsyncAsync client implementation for OracleDbAzureVault service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, 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 classOracleDbAzureVaultAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for OracleDbAzureVault.
-
Constructor Summary
Constructors Constructor Description OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.OracleDbAzureVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.OracleDbAzureVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.OracleDbAzureVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OracleDbAzureVaultAsyncClient.Builderbuilder()Create a builder for this client.Future<ChangeOracleDbAzureVaultCompartmentResponse>changeOracleDbAzureVaultCompartment(ChangeOracleDbAzureVaultCompartmentRequest request, AsyncHandler<ChangeOracleDbAzureVaultCompartmentRequest,ChangeOracleDbAzureVaultCompartmentResponse> handler)Moves the DB Azure Vault resource into a different compartment.protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>>
ClientCall<REQ,RESP,RESP_BUILDER>clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)voidclose()Future<CreateOracleDbAzureVaultResponse>createOracleDbAzureVault(CreateOracleDbAzureVaultRequest request, AsyncHandler<CreateOracleDbAzureVaultRequest,CreateOracleDbAzureVaultResponse> handler)Creates DB Azure Vault resource.Future<DeleteOracleDbAzureVaultResponse>deleteOracleDbAzureVault(DeleteOracleDbAzureVaultRequest request, AsyncHandler<DeleteOracleDbAzureVaultRequest,DeleteOracleDbAzureVaultResponse> handler)Deletes the DB Azure Vault resource.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.Future<GetOracleDbAzureVaultResponse>getOracleDbAzureVault(GetOracleDbAzureVaultRequest request, AsyncHandler<GetOracleDbAzureVaultRequest,GetOracleDbAzureVaultResponse> handler)Retrieves detailed information about an Oracle Database Azure Vault resource using its unique resource OCID.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.Future<ListOracleDbAzureVaultsResponse>listOracleDbAzureVaults(ListOracleDbAzureVaultsRequest request, AsyncHandler<ListOracleDbAzureVaultsRequest,ListOracleDbAzureVaultsResponse> handler)Lists all DB Azure Vault resources based on the specified filters.voidrefreshClient()Rebuild the backingHttpClient.Future<RefreshOracleDbAzureVaultResponse>refreshOracleDbAzureVault(RefreshOracleDbAzureVaultRequest request, AsyncHandler<RefreshOracleDbAzureVaultRequest,RefreshOracleDbAzureVaultResponse> handler)Refreshes the Oracle DB Azure Vault resource.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).Future<UpdateOracleDbAzureVaultResponse>updateOracleDbAzureVault(UpdateOracleDbAzureVaultRequest request, AsyncHandler<UpdateOracleDbAzureVaultRequest,UpdateOracleDbAzureVaultResponse> handler)Modifies the configuration details of an existing Oracle Database Azure Vault resource identified by its unique OCID.voiduseRealmSpecificEndpointTemplate(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.dbmulticloud.OracleDbAzureVaultAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
OracleDbAzureVaultAsyncClient
@Deprecated public OracleDbAzureVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOracleDbAzureVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
OracleDbAzureVaultAsyncClient
@Deprecated public OracleDbAzureVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOracleDbAzureVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
OracleDbAzureVaultAsyncClient
@Deprecated public OracleDbAzureVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOracleDbAzureVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
OracleDbAzureVaultAsyncClient
@Deprecated public OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOracleDbAzureVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
OracleDbAzureVaultAsyncClient
@Deprecated public OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOracleDbAzureVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
OracleDbAzureVaultAsyncClient
@Deprecated public OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOracleDbAzureVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
OracleDbAzureVaultAsyncClient
@Deprecated public OracleDbAzureVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOracleDbAzureVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static OracleDbAzureVaultAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:OracleDbAzureVaultAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceOracleDbAzureVaultAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:OracleDbAzureVaultAsyncSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceOracleDbAzureVaultAsync- Parameters:
regionId- The public region ID.
-
changeOracleDbAzureVaultCompartment
public Future<ChangeOracleDbAzureVaultCompartmentResponse> changeOracleDbAzureVaultCompartment(ChangeOracleDbAzureVaultCompartmentRequest request, AsyncHandler<ChangeOracleDbAzureVaultCompartmentRequest,ChangeOracleDbAzureVaultCompartmentResponse> handler)
Description copied from interface:OracleDbAzureVaultAsyncMoves the DB Azure Vault resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
- Specified by:
changeOracleDbAzureVaultCompartmentin interfaceOracleDbAzureVaultAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
createOracleDbAzureVault
public Future<CreateOracleDbAzureVaultResponse> createOracleDbAzureVault(CreateOracleDbAzureVaultRequest request, AsyncHandler<CreateOracleDbAzureVaultRequest,CreateOracleDbAzureVaultResponse> handler)
Description copied from interface:OracleDbAzureVaultAsyncCreates DB Azure Vault resource.- Specified by:
createOracleDbAzureVaultin interfaceOracleDbAzureVaultAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
deleteOracleDbAzureVault
public Future<DeleteOracleDbAzureVaultResponse> deleteOracleDbAzureVault(DeleteOracleDbAzureVaultRequest request, AsyncHandler<DeleteOracleDbAzureVaultRequest,DeleteOracleDbAzureVaultResponse> handler)
Description copied from interface:OracleDbAzureVaultAsyncDeletes the DB Azure Vault resource.- Specified by:
deleteOracleDbAzureVaultin interfaceOracleDbAzureVaultAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
getOracleDbAzureVault
public Future<GetOracleDbAzureVaultResponse> getOracleDbAzureVault(GetOracleDbAzureVaultRequest request, AsyncHandler<GetOracleDbAzureVaultRequest,GetOracleDbAzureVaultResponse> handler)
Description copied from interface:OracleDbAzureVaultAsyncRetrieves detailed information about an Oracle Database Azure Vault resource using its unique resource OCID.This operation returns metadata and configuration details associated with the specified vault resource.
- Specified by:
getOracleDbAzureVaultin interfaceOracleDbAzureVaultAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listOracleDbAzureVaults
public Future<ListOracleDbAzureVaultsResponse> listOracleDbAzureVaults(ListOracleDbAzureVaultsRequest request, AsyncHandler<ListOracleDbAzureVaultsRequest,ListOracleDbAzureVaultsResponse> handler)
Description copied from interface:OracleDbAzureVaultAsyncLists all DB Azure Vault resources based on the specified filters.- Specified by:
listOracleDbAzureVaultsin interfaceOracleDbAzureVaultAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
refreshOracleDbAzureVault
public Future<RefreshOracleDbAzureVaultResponse> refreshOracleDbAzureVault(RefreshOracleDbAzureVaultRequest request, AsyncHandler<RefreshOracleDbAzureVaultRequest,RefreshOracleDbAzureVaultResponse> handler)
Description copied from interface:OracleDbAzureVaultAsyncRefreshes the Oracle DB Azure Vault resource.- Specified by:
refreshOracleDbAzureVaultin interfaceOracleDbAzureVaultAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
updateOracleDbAzureVault
public Future<UpdateOracleDbAzureVaultResponse> updateOracleDbAzureVault(UpdateOracleDbAzureVaultRequest request, AsyncHandler<UpdateOracleDbAzureVaultRequest,UpdateOracleDbAzureVaultResponse> handler)
Description copied from interface:OracleDbAzureVaultAsyncModifies the configuration details of an existing Oracle Database Azure Vault resource identified by its unique OCID.This operation updates only the specified fields in the request body.
- Specified by:
updateOracleDbAzureVaultin interfaceOracleDbAzureVaultAsync- Parameters:
request- The request object containing the details to sendhandler- 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()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
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)
-
-