@Generated(value="OracleSDKGenerator", comments="API Version: release") public class KmsVaultClient extends Object implements KmsVault
Modifier and Type | Class and Description |
---|---|
static class |
KmsVaultClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for KmsVault.
|
Modifier | Constructor and Description |
---|---|
|
KmsVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
KmsVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
KmsVaultClient(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.
|
|
KmsVaultClient(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.
|
|
KmsVaultClient(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 |
KmsVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
KmsVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
KmsVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
KmsVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
BackupVaultResponse |
backupVault(BackupVaultRequest request)
Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.
|
static KmsVaultClient.Builder |
builder()
Create a builder for this client.
|
CancelVaultDeletionResponse |
cancelVaultDeletion(CancelVaultDeletionRequest request)
Cancels the scheduled deletion of the specified vault.
|
ChangeVaultCompartmentResponse |
changeVaultCompartment(ChangeVaultCompartmentRequest request)
Moves a vault into a different compartment within the same tenancy.
|
void |
close() |
CreateVaultResponse |
createVault(CreateVaultRequest request)
Creates a new vault.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
GetVaultUsageResponse |
getVaultUsage(GetVaultUsageRequest request)
Gets the count of keys and key versions in the specified vault to calculate usage against service limits.
|
KmsVaultWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListVaultsResponse |
listVaults(ListVaultsRequest request)
Lists the vaults in the specified compartment.
|
RestoreVaultFromFileResponse |
restoreVaultFromFile(RestoreVaultFromFileRequest request)
Restores a vault from an encrypted backup file.
|
RestoreVaultFromObjectStoreResponse |
restoreVaultFromObjectStore(RestoreVaultFromObjectStoreRequest request)
Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object
Storage.
|
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.
|
public static final Service SERVICE
Service instance for KmsVault.
public KmsVaultClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public KmsVaultClient(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 KmsVaultClient(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 KmsVaultClient(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 KmsVaultClient(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 KmsVaultClient(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 KmsVaultClient(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 KmsVaultClient(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.
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
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected KmsVaultClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, 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.
Use the KmsVaultClient.Builder
to get access to all these 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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static KmsVaultClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
KmsVault
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface KmsVault
endpoint
- The endpoint of the service.public String getEndpoint()
KmsVault
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface KmsVault
public void setRegion(Region region)
KmsVault
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.
public void setRegion(String regionId)
KmsVault
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
.
public void close()
close
in interface AutoCloseable
public BackupVaultResponse backupVault(BackupVaultRequest request)
KmsVault
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.
backupVault
in interface KmsVault
request
- The request object containing the details to sendpublic CancelVaultDeletionResponse cancelVaultDeletion(CancelVaultDeletionRequest request)
KmsVault
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.
cancelVaultDeletion
in interface KmsVault
request
- The request object containing the details to sendpublic ChangeVaultCompartmentResponse changeVaultCompartment(ChangeVaultCompartmentRequest request)
KmsVault
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.
changeVaultCompartment
in interface KmsVault
request
- The request object containing the details to sendpublic CreateVaultResponse createVault(CreateVaultRequest request)
KmsVault
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.
createVault
in interface KmsVault
request
- The request object containing the details to sendpublic GetVaultResponse getVault(GetVaultRequest request)
KmsVault
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.
public GetVaultUsageResponse getVaultUsage(GetVaultUsageRequest request)
KmsVault
Gets the count of keys and key versions in the specified vault to calculate usage against service limits.
getVaultUsage
in interface KmsVault
request
- The request object containing the details to sendpublic ListVaultsResponse listVaults(ListVaultsRequest request)
KmsVault
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.
listVaults
in interface KmsVault
request
- The request object containing the details to sendpublic RestoreVaultFromFileResponse restoreVaultFromFile(RestoreVaultFromFileRequest request)
KmsVault
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.
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.
restoreVaultFromFile
in interface KmsVault
request
- The request object containing the details to sendpublic RestoreVaultFromObjectStoreResponse restoreVaultFromObjectStore(RestoreVaultFromObjectStoreRequest request)
KmsVault
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.
restoreVaultFromObjectStore
in interface KmsVault
request
- The request object containing the details to sendpublic ScheduleVaultDeletionResponse scheduleVaultDeletion(ScheduleVaultDeletionRequest request)
KmsVault
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.
scheduleVaultDeletion
in interface KmsVault
request
- The request object containing the details to sendpublic UpdateVaultResponse updateVault(UpdateVaultRequest request)
KmsVault
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.
updateVault
in interface KmsVault
request
- The request object containing the details to sendpublic KmsVaultWaiters getWaiters()
KmsVault
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface KmsVault
public KmsVaultPaginators getPaginators()
KmsVault
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.
getPaginators
in interface KmsVault
Copyright © 2016–2021. All rights reserved.