KmsManagementClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.keymanagement.KmsManagementClient

All Implemented Interfaces:: KmsManagement, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public class KmsManagementClient
extends Object
implements KmsManagement

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for KmsManagement.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for KmsManagement.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`KmsManagementClient(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.
	`KmsManagementClient(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.
	`KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupKeyResponse`	`backupKey(BackupKeyRequest request)` Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later.
`static KmsManagementClientBuilder`	`builder()` Create a builder for this client.
`CancelKeyDeletionResponse`	`cancelKeyDeletion(CancelKeyDeletionRequest request)` Cancels the scheduled deletion of the specified key.
`CancelKeyVersionDeletionResponse`	`cancelKeyVersionDeletion(CancelKeyVersionDeletionRequest request)` Cancels the scheduled deletion of the specified key version.
`ChangeKeyCompartmentResponse`	`changeKeyCompartment(ChangeKeyCompartmentRequest request)` Moves a key into a different compartment within the same tenancy.
`void`	`close()`
`CreateKeyResponse`	`createKey(CreateKeyRequest request)` Creates a new master encryption key.
`CreateKeyVersionResponse`	`createKeyVersion(CreateKeyVersionRequest request)` Generates a new KeyVersion resource that provides new cryptographic material for a master encryption key.
`DisableKeyResponse`	`disableKey(DisableKeyRequest request)` Disables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys.
`EnableKeyResponse`	`enableKey(EnableKeyRequest request)` Enables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetKeyResponse`	`getKey(GetKeyRequest request)` Gets information about the specified master encryption key.
`GetKeyVersionResponse`	`getKeyVersion(GetKeyVersionRequest request)` Gets information about the specified key version.
`KmsManagementPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetReplicationStatusResponse`	`getReplicationStatus(GetReplicationStatusRequest request)` When a vault has a replica, each operation on the vault or its resources, such as keys, is replicated and has an associated replicationId.
`KmsManagementWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWrappingKeyResponse`	`getWrappingKey(GetWrappingKeyRequest request)` Gets details about the public RSA wrapping key associated with the vault in the endpoint.
`ImportKeyResponse`	`importKey(ImportKeyRequest request)` Imports AES key material to create a new key with.
`ImportKeyVersionResponse`	`importKeyVersion(ImportKeyVersionRequest request)` Imports AES key material to create a new key version with, and then rotates the key to begin using the new key version.
`ListKeysResponse`	`listKeys(ListKeysRequest request)` Lists the master encryption keys in the specified vault and compartment.
`ListKeyVersionsResponse`	`listKeyVersions(ListKeyVersionsRequest request)` Lists all KeyVersion resources for the specified master encryption key.
`RestoreKeyFromFileResponse`	`restoreKeyFromFile(RestoreKeyFromFileRequest request)` Restores the specified key to the specified vault, based on information in the backup file provided.
`RestoreKeyFromObjectStoreResponse`	`restoreKeyFromObjectStore(RestoreKeyFromObjectStoreRequest request)` Restores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location.
`ScheduleKeyDeletionResponse`	`scheduleKeyDeletion(ScheduleKeyDeletionRequest request)` Schedules the deletion of the specified key.
`ScheduleKeyVersionDeletionResponse`	`scheduleKeyVersionDeletion(ScheduleKeyVersionDeletionRequest request)` Schedules the deletion of the specified key version.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`UpdateKeyResponse`	`updateKey(UpdateKeyRequest request)` Updates the properties of a master encryption key.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for KmsManagement.
- Constructor Detail
  - KmsManagementClient
```
public KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - KmsManagementClient
```
public KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - KmsManagementClient
```
public KmsManagementClient(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.
    
    Parameters:
    
    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.
  - KmsManagementClient
```
public KmsManagementClient(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.
    
    Parameters:
    
    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.
  - KmsManagementClient
```
public KmsManagementClient(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.
    
    Parameters:
    
    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.
  - KmsManagementClient
```
public KmsManagementClient(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.
    
    Parameters:
    
    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)
  - KmsManagementClient
```
public KmsManagementClient(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.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - KmsManagementClient
```
public KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint,
                           ExecutorService executorService)
```
    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.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - KmsManagementClient
```
protected KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                              List<ClientConfigurator> additionalClientConfigurators,
                              String endpoint,
                              ExecutorService executorService,
                              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. Use the Builder to get access to all these parameters.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static KmsManagementClientBuilder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: KmsManagement
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface KmsManagement
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: KmsManagement
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface KmsManagement
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - backupKey
```
public BackupKeyResponse backupKey(BackupKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Backs 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.
    
    Specified by:
    
    backupKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - cancelKeyDeletion
```
public CancelKeyDeletionResponse cancelKeyDeletion(CancelKeyDeletionRequest request)
```
    Description copied from interface: KmsManagement
    
    Cancels 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.
    
    Specified by:
    
    cancelKeyDeletion in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - cancelKeyVersionDeletion
```
public CancelKeyVersionDeletionResponse cancelKeyVersionDeletion(CancelKeyVersionDeletionRequest request)
```
    Description copied from interface: KmsManagement
    
    Cancels 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.
    
    Specified by:
    
    cancelKeyVersionDeletion in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeKeyCompartment
```
public ChangeKeyCompartmentResponse changeKeyCompartment(ChangeKeyCompartmentRequest request)
```
    Description copied from interface: KmsManagement
    
    Moves 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.
    
    Specified by:
    
    changeKeyCompartment in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createKey
```
public CreateKeyResponse createKey(CreateKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Creates 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.
    
    Specified by:
    
    createKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createKeyVersion
```
public CreateKeyVersionResponse createKeyVersion(CreateKeyVersionRequest request)
```
    Description copied from interface: KmsManagement
    
    Generates 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.
    
    Specified by:
    
    createKeyVersion in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - disableKey
```
public DisableKeyResponse disableKey(DisableKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Disables 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.
    
    Specified by:
    
    disableKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - enableKey
```
public EnableKeyResponse enableKey(EnableKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Enables 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.
    
    Specified by:
    
    enableKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getKey
```
public GetKeyResponse getKey(GetKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Gets 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.
    
    Specified by:
    
    getKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getKeyVersion
```
public GetKeyVersionResponse getKeyVersion(GetKeyVersionRequest request)
```
    Description copied from interface: KmsManagement
    
    Gets 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.
    
    Specified by:
    
    getKeyVersion in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getReplicationStatus
```
public GetReplicationStatusResponse getReplicationStatus(GetReplicationStatusRequest request)
```
    Description copied from interface: KmsManagement
    
    When a vault has a replica, each operation on the vault or its resources, such as keys, is replicated and has an associated replicationId. Replication status provides details about whether the operation associated with the given replicationId has been successfully applied across replicas.
    
    Specified by:
    
    getReplicationStatus in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWrappingKey
```
public GetWrappingKeyResponse getWrappingKey(GetWrappingKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Gets 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.
    
    Specified by:
    
    getWrappingKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - importKey
```
public ImportKeyResponse importKey(ImportKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Imports 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.
    
    Specified by:
    
    importKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - importKeyVersion
```
public ImportKeyVersionResponse importKeyVersion(ImportKeyVersionRequest request)
```
    Description copied from interface: KmsManagement
    
    Imports 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.
    
    Specified by:
    
    importKeyVersion in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listKeyVersions
```
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request)
```
    Description copied from interface: KmsManagement
    
    Lists 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.
    
    Specified by:
    
    listKeyVersions in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listKeys
```
public ListKeysResponse listKeys(ListKeysRequest request)
```
    Description copied from interface: KmsManagement
    
    Lists 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.
    
    Specified by:
    
    listKeys in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restoreKeyFromFile
```
public RestoreKeyFromFileResponse restoreKeyFromFile(RestoreKeyFromFileRequest request)
```
    Description copied from interface: KmsManagement
    
    Restores 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.
    
    Note: This operation consumes a stream.
    
    If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this operation is called}.
    
    Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation was called.
    
    If the stream is a FileInputStream, and the stream’s FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream’s FileChannel position cannot be changed (like for a named pipe), then the stream’s contents will be buffered in memory, as described below.
    
    If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.
    
    The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.
    
    Specified by:
    
    restoreKeyFromFile in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restoreKeyFromObjectStore
```
public RestoreKeyFromObjectStoreResponse restoreKeyFromObjectStore(RestoreKeyFromObjectStoreRequest request)
```
    Description copied from interface: KmsManagement
    
    Restores 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.
    
    Specified by:
    
    restoreKeyFromObjectStore in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - scheduleKeyDeletion
```
public ScheduleKeyDeletionResponse scheduleKeyDeletion(ScheduleKeyDeletionRequest request)
```
    Description copied from interface: KmsManagement
    
    Schedules 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.
    
    Specified by:
    
    scheduleKeyDeletion in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - scheduleKeyVersionDeletion
```
public ScheduleKeyVersionDeletionResponse scheduleKeyVersionDeletion(ScheduleKeyVersionDeletionRequest request)
```
    Description copied from interface: KmsManagement
    
    Schedules 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.
    
    Specified by:
    
    scheduleKeyVersionDeletion in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateKey
```
public UpdateKeyResponse updateKey(UpdateKeyRequest request)
```
    Description copied from interface: KmsManagement
    
    Updates the properties of a master encryption key. Specifically, you can update the displayName, freeformTags, and definedTags properties. Furthermore, the key must be 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.
    
    Specified by:
    
    updateKey in interface KmsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public KmsManagementWaiters getWaiters()
```
    Description copied from interface: KmsManagement
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface KmsManagement
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public KmsManagementPaginators getPaginators()
```
    Description copied from interface: KmsManagement
    
    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 interface KmsManagement
    
    Returns:
    
    The service paginators.

Class KmsManagementClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

KmsManagementClient

KmsManagementClient

KmsManagementClient

KmsManagementClient

KmsManagementClient

KmsManagementClient

KmsManagementClient

KmsManagementClient

KmsManagementClient

Method Detail

builder

setEndpoint

getEndpoint

close

backupKey

cancelKeyDeletion

cancelKeyVersionDeletion

changeKeyCompartment

createKey

createKeyVersion

disableKey

enableKey

getKey

getKeyVersion

getReplicationStatus

getWrappingKey

importKey

importKeyVersion

listKeyVersions

listKeys

restoreKeyFromFile

restoreKeyFromObjectStore

scheduleKeyDeletion

scheduleKeyVersionDeletion

updateKey

getWaiters

getPaginators