@Generated(value="OracleSDKGenerator",
comments="API Version: release")
public class KmsVaultAsyncClient
extends BaseAsyncClient
implements KmsVaultAsync
Async client implementation for KmsVault 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
| Modifier and Type | Class and Description |
|---|---|
static class |
KmsVaultAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and 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 KmsVault.
|
| Constructor and Description |
|---|
KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplateclosepublic static final Service SERVICE
Service instance for KmsVault.
public final String clientCommonLibraryVersion
@Deprecated public KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see KmsVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))@Deprecated public KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see KmsVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configuration@Deprecated public KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see KmsVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)@Deprecated public KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see KmsVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory@Deprecated public KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see KmsVaultAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration - ClientBuilderBase.configurationclientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators@Deprecated public KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see KmsVaultAsyncClient.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)@Deprecated public KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder instead.Create a new client instance.
authenticationDetailsProvider - The authentication details (see KmsVaultAsyncClient.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.signingStrategyRequestSignerFactoriespublic static KmsVaultAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
KmsVaultAsyncSets 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.
setRegion in interface KmsVaultAsyncregion - The region of the service.public void setRegion(String regionId)
KmsVaultAsyncSets 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.
setRegion in interface KmsVaultAsyncregionId - The public region ID.public Future<BackupVaultResponse> backupVault(BackupVaultRequest request, AsyncHandler<BackupVaultRequest,BackupVaultResponse> handler)
KmsVaultAsyncBacks up an encrypted file that contains all the metadata of a vault so that you can restore the vault later. You can backup a vault whether or not it contains keys. This operation only backs up the metadata of the vault, and does not include key metadata.
backupVault in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CancelVaultDeletionResponse> cancelVaultDeletion(CancelVaultDeletionRequest request, AsyncHandler<CancelVaultDeletionRequest,CancelVaultDeletionResponse> handler)
KmsVaultAsyncCancels the scheduled deletion of the specified vault. Canceling a scheduled deletion restores the vault and all keys in it to their respective states from before their scheduled deletion. All keys that were scheduled for deletion prior to vault deletion retain their lifecycle state and time of deletion.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
cancelVaultDeletion in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeVaultCompartmentResponse> changeVaultCompartment(ChangeVaultCompartmentRequest request, AsyncHandler<ChangeVaultCompartmentRequest,ChangeVaultCompartmentResponse> handler)
KmsVaultAsyncMoves a vault into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When provided, if-match is checked against the ETag values of the resource.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
changeVaultCompartment in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateVaultResponse> createVault(CreateVaultRequest request, AsyncHandler<CreateVaultRequest,CreateVaultResponse> handler)
KmsVaultAsyncCreates a new vault. The type of vault you create determines key placement, pricing, and available options. Options include storage isolation, a dedicated service endpoint instead of a shared service endpoint for API calls, and either a dedicated hardware security module (HSM) or a multitenant HSM.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
createVault in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateVaultReplicaResponse> createVaultReplica(CreateVaultReplicaRequest request, AsyncHandler<CreateVaultReplicaRequest,CreateVaultReplicaResponse> handler)
KmsVaultAsyncCreates a replica for the vault in another region in the same realm
The API is a no-op if called for same region that a vault is already replicated to. 409 if called on a vault that is already replicated to a different region. Users need to delete existing replica first before calling it with a different region.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
createVaultReplica in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteVaultReplicaResponse> deleteVaultReplica(DeleteVaultReplicaRequest request, AsyncHandler<DeleteVaultReplicaRequest,DeleteVaultReplicaResponse> handler)
KmsVaultAsyncDeletes a vault replica
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
deleteVaultReplica in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetVaultResponse> getVault(GetVaultRequest request, AsyncHandler<GetVaultRequest,GetVaultResponse> handler)
KmsVaultAsyncGets the specified vault’s configuration information.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.
getVault in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetVaultUsageResponse> getVaultUsage(GetVaultUsageRequest request, AsyncHandler<GetVaultUsageRequest,GetVaultUsageResponse> handler)
KmsVaultAsyncGets the count of keys and key versions in the specified vault to calculate usage against service limits.
getVaultUsage in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListVaultReplicasResponse> listVaultReplicas(ListVaultReplicasRequest request, AsyncHandler<ListVaultReplicasRequest,ListVaultReplicasResponse> handler)
KmsVaultAsyncLists the replicas for a vault
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
listVaultReplicas in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListVaultsResponse> listVaults(ListVaultsRequest request, AsyncHandler<ListVaultsRequest,ListVaultsResponse> handler)
KmsVaultAsyncLists the vaults in the specified compartment.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.
listVaults in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<RestoreVaultFromFileResponse> restoreVaultFromFile(RestoreVaultFromFileRequest request, AsyncHandler<RestoreVaultFromFileRequest,RestoreVaultFromFileResponse> handler)
KmsVaultAsyncRestores a vault from an encrypted backup file. If a vault with the same OCID already exists, this operation returns a response with a 409 HTTP status error code.
restoreVaultFromFile in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<RestoreVaultFromObjectStoreResponse> restoreVaultFromObjectStore(RestoreVaultFromObjectStoreRequest request, AsyncHandler<RestoreVaultFromObjectStoreRequest,RestoreVaultFromObjectStoreResponse> handler)
KmsVaultAsyncRestores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object Storage. If a vault with the same OCID already exists, this operation returns a response with a 409 HTTP status error code.
restoreVaultFromObjectStore in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ScheduleVaultDeletionResponse> scheduleVaultDeletion(ScheduleVaultDeletionRequest request, AsyncHandler<ScheduleVaultDeletionRequest,ScheduleVaultDeletionResponse> handler)
KmsVaultAsyncSchedules the deletion of the specified vault. This sets the lifecycle state of the vault and
all keys in it that are not already scheduled for deletion to PENDING_DELETION and then
deletes them after the retention period ends. The lifecycle state and time of deletion for
keys already scheduled for deletion won’t change. If any keys in the vault are scheduled to
be deleted after the specified time of deletion for the vault, the call is rejected with the
error code 409.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
scheduleVaultDeletion in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateVaultResponse> updateVault(UpdateVaultRequest request, AsyncHandler<UpdateVaultRequest,UpdateVaultResponse> handler)
KmsVaultAsyncUpdates the properties of a vault. Specifically, you can update the displayName,
freeformTags, and definedTags properties. Furthermore, the vault must be in an ACTIVE or
CREATING state to be updated.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
updateVault in interface KmsVaultAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint - The endpoint template in userequiredParametersMap - Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint - The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient. This will call ClientConfigurators again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close in interface AutoCloseablepublic String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
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)
Copyright © 2016–2024. All rights reserved.