Get the endpoint that is being used to call (ex, https://www.example.com).
Sets the endpoint to call (ex, https://www.example.com).
The endpoint of the service.
Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
The region of the service.
Sets the regionId to call (ex, 'us-phoenix-1').
Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.
The public region ID.
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
flag to enable the use of realm specific endpoint template
Backs 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.
This operation does not retry by default if the user has not defined a retry configuration.
BackupVaultResponse
Cancels 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.
This operation does not retry by default if the user has not defined a retry configuration.
CancelVaultDeletionResponse
Moves 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.
This operation does not retry by default if the user has not defined a retry configuration.
ChangeVaultCompartmentResponse
Close the client once it is no longer needed
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 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.
This operation does not retry by default if the user has not defined a retry configuration.
CreateVaultResponse
Creates 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.
This operation does not retry by default if the user has not defined a retry configuration.
CreateVaultReplicaResponse
Creates a new KmsVaultWaiter for resources for this service.
The waiter configuration for termination and delay strategy
The service waiters.
Deletes 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.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteVaultReplicaResponse
Gets 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.
This operation does not retry by default if the user has not defined a retry configuration.
GetVaultResponse
Gets the count of keys and key versions in the specified vault to calculate usage against service limits.
This operation does not retry by default if the user has not defined a retry configuration.
GetVaultUsageResponse
Gets the waiters available for resources for this service.
The service waiters.
NOTE: This function is deprecated in favor of listVaultReplicasRecordIterator function. Creates a new async iterator which will iterate over the models.VaultReplicaSummary objects contained in responses from the listVaultReplicas operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listVaultReplicasResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVaultReplicas operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listVaultsRecordIterator function. Creates a new async iterator which will iterate over the models.VaultSummary objects contained in responses from the listVaults operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listVaultsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVaults operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists 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.
This operation does not retry by default if the user has not defined a retry configuration.
ListVaultReplicasResponse
Creates a new async iterator which will iterate over the models.VaultReplicaSummary objects contained in responses from the listVaultReplicas operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listVaultReplicas operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists 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.
This operation does not retry by default if the user has not defined a retry configuration.
ListVaultsResponse
Creates a new async iterator which will iterate over the models.VaultSummary objects contained in responses from the listVaults operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listVaults operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Restores 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.
This operation does not retry by default if the user has not defined a retry configuration.
RestoreVaultFromFileResponse
Restores 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.
This operation does not retry by default if the user has not defined a retry configuration.
RestoreVaultFromObjectStoreResponse
Schedules 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.
This operation does not retry by default if the user has not defined a retry configuration.
ScheduleVaultDeletionResponse
Shutdown the circuit breaker used by the client when it is no longer needed
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.
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.
This operation does not retry by default if the user has not defined a retry configuration.
UpdateVaultResponse
This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.