@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public interface KmsVault extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
CancelVaultDeletionResponse |
cancelVaultDeletion(CancelVaultDeletionRequest request)
Cancels the scheduled deletion of the specified vault.
|
CreateVaultResponse |
createVault(CreateVaultRequest request)
Creates a new vault.
|
KmsVaultPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
GetVaultResponse |
getVault(GetVaultRequest request)
Gets the specified vault’s configuration information.
|
KmsVaultWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListVaultsResponse |
listVaults(ListVaultsRequest request)
Lists the vaults in the specified compartment.
|
ScheduleVaultDeletionResponse |
scheduleVaultDeletion(ScheduleVaultDeletionRequest request)
Schedules the deletion of the specified vault.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateVaultResponse |
updateVault(UpdateVaultRequest request)
Updates the properties of a vault.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.CancelVaultDeletionResponse cancelVaultDeletion(CancelVaultDeletionRequest request)
Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion restores the vault and all keys in it to the respective states they were in before the deletion was scheduled.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateVaultResponse createVault(CreateVaultRequest request)
Creates 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 a dedicated hardware security module (HSM) or a multitenant HSM.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVaultResponse getVault(GetVaultRequest request)
Gets the specified vault’s configuration information.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListVaultsResponse listVaults(ListVaultsRequest request)
Lists the vaults in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ScheduleVaultDeletionResponse scheduleVaultDeletion(ScheduleVaultDeletionRequest request)
Schedules the deletion of the specified vault. This sets the state of the vault and all keys in it to PENDING_DELETION
and then deletes them after the retention period ends.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateVaultResponse updateVault(UpdateVaultRequest request)
Updates 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.
request
- The request object containing the details to sendBmcException
- when an error occurs.KmsVaultWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
KmsVaultPaginators 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.