@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public interface KmsManagement extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
CreateKeyResponse |
createKey(CreateKeyRequest request)
Creates a new key.
|
CreateKeyVersionResponse |
createKeyVersion(CreateKeyVersionRequest request)
Generates new cryptographic material for a key.
|
DisableKeyResponse |
disableKey(DisableKeyRequest request)
Disables a key to make it unavailable for encryption or decryption.
|
EnableKeyResponse |
enableKey(EnableKeyRequest request)
Enables a key to make it available for encryption or decryption.
|
GetKeyResponse |
getKey(GetKeyRequest request)
Gets information about the specified 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.
|
KmsManagementWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListKeysResponse |
listKeys(ListKeysRequest request)
Lists the keys in the specified vault and compartment.
|
ListKeyVersionsResponse |
listKeyVersions(ListKeyVersionsRequest request)
Lists all key versions for the specified key.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
UpdateKeyResponse |
updateKey(UpdateKeyRequest request)
Updates the properties of a key.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.CreateKeyResponse createKey(CreateKeyRequest request)
Creates a new key.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateKeyVersionResponse createKeyVersion(CreateKeyVersionRequest request)
Generates new cryptographic material for a key. The key must be in an ENABLED
state to be rotated.
request
- The request object containing the details to sendBmcException
- when an error occurs.DisableKeyResponse disableKey(DisableKeyRequest request)
Disables a key to make it unavailable for encryption or decryption.
request
- The request object containing the details to sendBmcException
- when an error occurs.EnableKeyResponse enableKey(EnableKeyRequest request)
Enables a key to make it available for encryption or decryption.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetKeyResponse getKey(GetKeyRequest request)
Gets information about the specified key.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetKeyVersionResponse getKeyVersion(GetKeyVersionRequest request)
Gets information about the specified key version.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request)
Lists all key versions for the specified key.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListKeysResponse listKeys(ListKeysRequest request)
Lists the keys in the specified vault and compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateKeyResponse updateKey(UpdateKeyRequest request)
Updates the properties of a key. Specifically, you can update the displayName
, freeformTags
, and definedTags
properties. Furthermore, the key must in an ACTIVE
or CREATING
state to be updated.
request
- The request object containing the details to sendBmcException
- when an error occurs.KmsManagementWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
KmsManagementPaginators getPaginators()
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.
Copyright © 2016–2019. All rights reserved.