Class OracleDbAzureVaultClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.dbmulticloud.OracleDbAzureVaultClient
-
- All Implemented Interfaces:
OracleDbAzureVault
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20240501") public class OracleDbAzureVaultClient extends BaseSyncClient implements OracleDbAzureVault
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OracleDbAzureVaultClient.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 OracleDbAzureVault.
-
Constructor Summary
Constructors Constructor Description OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.OracleDbAzureVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.OracleDbAzureVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.OracleDbAzureVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OracleDbAzureVaultClient.Builder
builder()
Create a builder for this client.ChangeOracleDbAzureVaultCompartmentResponse
changeOracleDbAzureVaultCompartment(ChangeOracleDbAzureVaultCompartmentRequest request)
Moves the DB Azure Vault resource into a different compartment.void
close()
CreateOracleDbAzureVaultResponse
createOracleDbAzureVault(CreateOracleDbAzureVaultRequest request)
Create DB Azure Vaults based on the provided information, this will fetch Keys related to Azure Vaults.DeleteOracleDbAzureVaultResponse
deleteOracleDbAzureVault(DeleteOracleDbAzureVaultRequest request)
Delete DB Azure Vault details.String
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
GetOracleDbAzureVaultResponse
getOracleDbAzureVault(GetOracleDbAzureVaultRequest request)
Get Oracle DB Azure Vault Details form a particular Container Resource ID.OracleDbAzureVaultPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.OracleDbAzureVaultWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListOracleDbAzureVaultsResponse
listOracleDbAzureVaults(ListOracleDbAzureVaultsRequest request)
Lists the all DB Azure Vaults based on filters.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 backingHttpClient
.RefreshOracleDbAzureVaultResponse
refreshOracleDbAzureVault(RefreshOracleDbAzureVaultRequest request)
Refresh Oracle DB Azure Vault details from backend.void
setEndpoint(String endpoint)
void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateOracleDbAzureVaultResponse
updateOracleDbAzureVault(UpdateOracleDbAzureVaultRequest request)
Modifies the existing Oracle DB Azure Vault Details for a given ID.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.dbmulticloud.OracleDbAzureVault
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.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)
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.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
-
OracleDbAzureVaultClient
@Deprecated public OracleDbAzureVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOracleDbAzureVaultClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-OracleDbAzureVaultClient.Builder.executorService
-
-
Method Detail
-
builder
public static OracleDbAzureVaultClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:OracleDbAzureVault
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 interfaceOracleDbAzureVault
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:OracleDbAzureVault
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceOracleDbAzureVault
- Parameters:
regionId
- The public region ID.
-
changeOracleDbAzureVaultCompartment
public ChangeOracleDbAzureVaultCompartmentResponse changeOracleDbAzureVaultCompartment(ChangeOracleDbAzureVaultCompartmentRequest request)
Description copied from interface:OracleDbAzureVault
Moves the DB Azure Vault resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
- Specified by:
changeOracleDbAzureVaultCompartment
in interfaceOracleDbAzureVault
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOracleDbAzureVault
public CreateOracleDbAzureVaultResponse createOracleDbAzureVault(CreateOracleDbAzureVaultRequest request)
Description copied from interface:OracleDbAzureVault
Create DB Azure Vaults based on the provided information, this will fetch Keys related to Azure Vaults.- Specified by:
createOracleDbAzureVault
in interfaceOracleDbAzureVault
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOracleDbAzureVault
public DeleteOracleDbAzureVaultResponse deleteOracleDbAzureVault(DeleteOracleDbAzureVaultRequest request)
Description copied from interface:OracleDbAzureVault
Delete DB Azure Vault details.- Specified by:
deleteOracleDbAzureVault
in interfaceOracleDbAzureVault
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOracleDbAzureVault
public GetOracleDbAzureVaultResponse getOracleDbAzureVault(GetOracleDbAzureVaultRequest request)
Description copied from interface:OracleDbAzureVault
Get Oracle DB Azure Vault Details form a particular Container Resource ID.- Specified by:
getOracleDbAzureVault
in interfaceOracleDbAzureVault
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOracleDbAzureVaults
public ListOracleDbAzureVaultsResponse listOracleDbAzureVaults(ListOracleDbAzureVaultsRequest request)
Description copied from interface:OracleDbAzureVault
Lists the all DB Azure Vaults based on filters.- Specified by:
listOracleDbAzureVaults
in interfaceOracleDbAzureVault
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshOracleDbAzureVault
public RefreshOracleDbAzureVaultResponse refreshOracleDbAzureVault(RefreshOracleDbAzureVaultRequest request)
Description copied from interface:OracleDbAzureVault
Refresh Oracle DB Azure Vault details from backend.- Specified by:
refreshOracleDbAzureVault
in interfaceOracleDbAzureVault
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOracleDbAzureVault
public UpdateOracleDbAzureVaultResponse updateOracleDbAzureVault(UpdateOracleDbAzureVaultRequest request)
Description copied from interface:OracleDbAzureVault
Modifies the existing Oracle DB Azure Vault Details for a given ID.- Specified by:
updateOracleDbAzureVault
in interfaceOracleDbAzureVault
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public OracleDbAzureVaultWaiters getWaiters()
Description copied from interface:OracleDbAzureVault
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceOracleDbAzureVault
- Returns:
- The service waiters.
-
getPaginators
public OracleDbAzureVaultPaginators getPaginators()
Description copied from interface:OracleDbAzureVault
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginators
in interfaceOracleDbAzureVault
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-