@Generated(value="OracleSDKGenerator", comments="API Version: release") public class KmsManagementAsyncClient extends Object implements KmsManagementAsync
Async client implementation for KmsManagement service.
There are two ways to use async client:
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. | Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for KmsManagement.
|
| Constructor and Description |
|---|
KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
KmsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for KmsManagement.
public KmsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public KmsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public KmsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public KmsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static KmsManagementAsyncClientBuilder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
KmsManagementAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface KmsManagementAsyncendpoint - The endpoint of the serice.public String getEndpoint()
KmsManagementAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface KmsManagementAsyncpublic void close()
close in interface AutoCloseablepublic Future<BackupKeyResponse> backupKey(BackupKeyRequest request, AsyncHandler<BackupKeyRequest,BackupKeyResponse> handler)
KmsManagementAsyncBacks up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later. The file also contains the metadata of the vault that the key belonged to.
backupKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CancelKeyDeletionResponse> cancelKeyDeletion(CancelKeyDeletionRequest request, AsyncHandler<CancelKeyDeletionRequest,CancelKeyDeletionResponse> handler)
KmsManagementAsyncCancels the scheduled deletion of the specified key. Canceling a scheduled deletion restores the key’s lifecycle state to what it was before its scheduled 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.
cancelKeyDeletion in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CancelKeyVersionDeletionResponse> cancelKeyVersionDeletion(CancelKeyVersionDeletionRequest request, AsyncHandler<CancelKeyVersionDeletionRequest,CancelKeyVersionDeletionResponse> handler)
KmsManagementAsyncCancels the scheduled deletion of the specified key version. Canceling a scheduled deletion restores the key version to its lifecycle state from before its scheduled 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.
cancelKeyVersionDeletion in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeKeyCompartmentResponse> changeKeyCompartment(ChangeKeyCompartmentRequest request, AsyncHandler<ChangeKeyCompartmentRequest,ChangeKeyCompartmentResponse> handler)
KmsManagementAsyncMoves a key 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 key.
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.
changeKeyCompartment in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateKeyResponse> createKey(CreateKeyRequest request, AsyncHandler<CreateKeyRequest,CreateKeyResponse> handler)
KmsManagementAsyncCreates a new master encryption key.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
createKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateKeyVersionResponse> createKeyVersion(CreateKeyVersionRequest request, AsyncHandler<CreateKeyVersionRequest,CreateKeyVersionResponse> handler)
KmsManagementAsyncGenerates a new KeyVersion resource that provides new cryptographic
material for a master encryption key. The key must be in an ENABLED state to be rotated.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
createKeyVersion in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DisableKeyResponse> disableKey(DisableKeyRequest request, AsyncHandler<DisableKeyRequest,DisableKeyResponse> handler)
KmsManagementAsyncDisables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
disableKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<EnableKeyResponse> enableKey(EnableKeyRequest request, AsyncHandler<EnableKeyRequest,EnableKeyResponse> handler)
KmsManagementAsyncEnables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
enableKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetKeyResponse> getKey(GetKeyRequest request, AsyncHandler<GetKeyRequest,GetKeyResponse> handler)
KmsManagementAsyncGets information about the specified master encryption key.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
getKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetKeyVersionResponse> getKeyVersion(GetKeyVersionRequest request, AsyncHandler<GetKeyVersionRequest,GetKeyVersionResponse> handler)
KmsManagementAsyncGets information about the specified key version.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
getKeyVersion in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetWrappingKeyResponse> getWrappingKey(GetWrappingKeyRequest request, AsyncHandler<GetWrappingKeyRequest,GetWrappingKeyResponse> handler)
KmsManagementAsyncGets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and unwraps AES key material for import into Key Management.
getWrappingKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ImportKeyResponse> importKey(ImportKeyRequest request, AsyncHandler<ImportKeyRequest,ImportKeyResponse> handler)
KmsManagementAsyncImports AES key material to create a new key with. The key material must be base64-encoded and wrapped by the vault’s public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match what you specify at the time of import.
importKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ImportKeyVersionResponse> importKeyVersion(ImportKeyVersionRequest request, AsyncHandler<ImportKeyVersionRequest,ImportKeyVersionResponse> handler)
KmsManagementAsyncImports AES key material to create a new key version with, and then rotates the key to begin using the new key version. The key material must be base64-encoded and wrapped by the vault’s public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match the length of the specified key and what you specify as the length at the time of import.
importKeyVersion in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListKeyVersionsResponse> listKeyVersions(ListKeyVersionsRequest request, AsyncHandler<ListKeyVersionsRequest,ListKeyVersionsResponse> handler)
KmsManagementAsyncLists all KeyVersion resources for the specified master encryption key.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
listKeyVersions in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListKeysResponse> listKeys(ListKeysRequest request, AsyncHandler<ListKeysRequest,ListKeysResponse> handler)
KmsManagementAsyncLists the master encryption keys in the specified vault and compartment.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
listKeys in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<RestoreKeyFromFileResponse> restoreKeyFromFile(RestoreKeyFromFileRequest request, AsyncHandler<RestoreKeyFromFileRequest,RestoreKeyFromFileResponse> handler)
KmsManagementAsyncRestores the specified key to the specified vault, based on information in the backup file provided. If the vault doesn’t exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
restoreKeyFromFile in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<RestoreKeyFromObjectStoreResponse> restoreKeyFromObjectStore(RestoreKeyFromObjectStoreRequest request, AsyncHandler<RestoreKeyFromObjectStoreRequest,RestoreKeyFromObjectStoreResponse> handler)
KmsManagementAsyncRestores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location. If the vault doesn’t exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
restoreKeyFromObjectStore in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ScheduleKeyDeletionResponse> scheduleKeyDeletion(ScheduleKeyDeletionRequest request, AsyncHandler<ScheduleKeyDeletionRequest,ScheduleKeyDeletionResponse> handler)
KmsManagementAsyncSchedules the deletion of the specified key. This sets the lifecycle state of the key
to PENDING_DELETION and then deletes it after the specified retention period ends.
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.
scheduleKeyDeletion in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ScheduleKeyVersionDeletionResponse> scheduleKeyVersionDeletion(ScheduleKeyVersionDeletionRequest request, AsyncHandler<ScheduleKeyVersionDeletionRequest,ScheduleKeyVersionDeletionResponse> handler)
KmsManagementAsyncSchedules the deletion of the specified key version. This sets the lifecycle state of the key version
to PENDING_DELETION and then deletes it after the specified retention period ends.
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.
scheduleKeyVersionDeletion in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateKeyResponse> updateKey(UpdateKeyRequest request, AsyncHandler<UpdateKeyRequest,UpdateKeyResponse> handler)
KmsManagementAsyncUpdates the properties of a master encryption key. Specifically, you can update the
displayName, freeformTags, and definedTags properties. Furthermore,
the key must in an ENABLED or CREATING state to be updated.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
updateKey in interface KmsManagementAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2021. All rights reserved.