@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public interface Vaults extends AutoCloseable
Use the Secret Management API to manage secrets and secret versions. For more information, see Managing Secrets. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
CancelSecretDeletionResponse |
cancelSecretDeletion(CancelSecretDeletionRequest request)
Cancels the pending deletion of the specified secret.
|
CancelSecretVersionDeletionResponse |
cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request)
Cancels the scheduled deletion of a secret version.
|
ChangeSecretCompartmentResponse |
changeSecretCompartment(ChangeSecretCompartmentRequest request)
Moves a secret into a different compartment within the same tenancy.
|
CreateSecretResponse |
createSecret(CreateSecretRequest request)
Creates a new secret according to the details of the request.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
VaultsPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetSecretResponse |
getSecret(GetSecretRequest request)
Gets information about the specified secret.
|
GetSecretVersionResponse |
getSecretVersion(GetSecretVersionRequest request)
Gets information about the specified version of a secret.
|
VaultsWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListSecretsResponse |
listSecrets(ListSecretsRequest request)
Lists all secrets in the specified vault and compartment.
|
ListSecretVersionsResponse |
listSecretVersions(ListSecretVersionsRequest request)
Lists all secret versions for the specified secret.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
ScheduleSecretDeletionResponse |
scheduleSecretDeletion(ScheduleSecretDeletionRequest request)
Schedules the deletion of the specified secret.
|
ScheduleSecretVersionDeletionResponse |
scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request)
Schedules the deletion of the specified secret version.
|
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’).
|
UpdateSecretResponse |
updateSecret(UpdateSecretRequest request)
Updates the properties of a secret.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateCancelSecretDeletionResponse cancelSecretDeletion(CancelSecretDeletionRequest request)
Cancels the pending deletion of the specified secret. Canceling a scheduled deletion restores the secret’s lifecycle state to what it was before you scheduled the secret for deletion.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelSecretDeletion API.
CancelSecretVersionDeletionResponse cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request)
Cancels the scheduled deletion of a secret version.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelSecretVersionDeletion API.
ChangeSecretCompartmentResponse changeSecretCompartment(ChangeSecretCompartmentRequest request)
Moves a secret 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 secret.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeSecretCompartment API.
CreateSecretResponse createSecret(CreateSecretRequest request)
Creates a new secret according to the details of the request.
This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSecret API.
GetSecretResponse getSecret(GetSecretRequest request)
Gets information about the specified secret.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecret API.
GetSecretVersionResponse getSecretVersion(GetSecretVersionRequest request)
Gets information about the specified version of a secret.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecretVersion API.
ListSecretVersionsResponse listSecretVersions(ListSecretVersionsRequest request)
Lists all secret versions for the specified secret.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecretVersions API.
ListSecretsResponse listSecrets(ListSecretsRequest request)
Lists all secrets in the specified vault and compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecrets API.
ScheduleSecretDeletionResponse scheduleSecretDeletion(ScheduleSecretDeletionRequest request)
Schedules the deletion of the specified secret. This sets the lifecycle state of the secret
to PENDING_DELETION
and then deletes it after the specified retention period ends.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ScheduleSecretDeletion API.
ScheduleSecretVersionDeletionResponse scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request)
Schedules the deletion of the specified secret version. This deletes it after the specified
retention period ends. You can only delete a secret version if the secret version rotation
state is marked as DEPRECATED
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ScheduleSecretVersionDeletion API.
UpdateSecretResponse updateSecret(UpdateSecretRequest request)
Updates the properties of a secret. Specifically, you can update the version number of the
secret to make that version number the current version. You can also update a secret’s
description, its free-form or defined tags, rules and the secret contents. Updating the
secret content automatically creates a new secret version. You cannot, however, update the
current secret version number, secret contents, and secret rules at the same time.
Furthermore, the secret must in an ACTIVE
lifecycle state to be updated.
This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSecret API.
VaultsWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
VaultsPaginators 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–2023. All rights reserved.