Class VaultsClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.vault.VaultsClient
-
- All Implemented Interfaces:
Vaults
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public class VaultsClient extends BaseSyncClient implements Vaults
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VaultsClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.protected ExecutorService
executorService
Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for Vaults.
-
Constructor Summary
Constructors Constructor Description VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VaultsClient.Builder
builder()
Create a builder for this client.CancelSecretDeletionResponse
cancelSecretDeletion(CancelSecretDeletionRequest request)
Cancels the pending deletion of the specified secret.CancelSecretRotationResponse
cancelSecretRotation(CancelSecretRotationRequest request)
Cancels the ongoing secret rotation.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.void
close()
CreateSecretResponse
createSecret(CreateSecretRequest request)
Creates a new secret according to the details of the request.String
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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.VaultsWaiters
newWaiters(WorkRequest workRequestClient)
Creates a new VaultsWaiters for resources for this service.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.RotateSecretResponse
rotateSecret(RotateSecretRequest request)
API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details objectScheduleSecretDeletionResponse
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)
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’).void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateSecretResponse
updateSecret(UpdateSecretRequest request)
Updates the properties of a secret.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.vault.Vaults
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Field Detail
-
SERVICE
public static final Service SERVICE
Service instance for Vaults.
-
executorService
protected final ExecutorService executorService
-
clientCommonLibraryVersion
public final String clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
-
-
Constructor Detail
-
VaultsClient
@Deprecated public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
VaultsClient
@Deprecated public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
VaultsClient
@Deprecated public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
VaultsClient
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
VaultsClient
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
VaultsClient
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
VaultsClient
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
VaultsClient
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeVaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-VaultsClient.Builder.executorService
-
-
Method Detail
-
builder
public static VaultsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:Vaults
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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:Vaults
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 callsetEndpoint
.
-
cancelSecretDeletion
public CancelSecretDeletionResponse cancelSecretDeletion(CancelSecretDeletionRequest request)
Description copied from interface:Vaults
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.
- Specified by:
cancelSecretDeletion
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelSecretRotation
public CancelSecretRotationResponse cancelSecretRotation(CancelSecretRotationRequest request)
Description copied from interface:Vaults
Cancels the ongoing secret rotation.The cancellation is contingent on how far the rotation process has progressed. Upon cancelling a rotation, all future rotations are also disabled.
- Specified by:
cancelSecretRotation
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelSecretVersionDeletion
public CancelSecretVersionDeletionResponse cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request)
Description copied from interface:Vaults
Cancels the scheduled deletion of a secret version.- Specified by:
cancelSecretVersionDeletion
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSecretCompartment
public ChangeSecretCompartmentResponse changeSecretCompartment(ChangeSecretCompartmentRequest request)
Description copied from interface:Vaults
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.
- Specified by:
changeSecretCompartment
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSecret
public CreateSecretResponse createSecret(CreateSecretRequest request)
Description copied from interface:Vaults
Creates a new secret according to the details of the request.This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.
- Specified by:
createSecret
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecret
public GetSecretResponse getSecret(GetSecretRequest request)
Description copied from interface:Vaults
Gets information about the specified secret.
-
getSecretVersion
public GetSecretVersionResponse getSecretVersion(GetSecretVersionRequest request)
Description copied from interface:Vaults
Gets information about the specified version of a secret.- Specified by:
getSecretVersion
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecretVersions
public ListSecretVersionsResponse listSecretVersions(ListSecretVersionsRequest request)
Description copied from interface:Vaults
Lists all secret versions for the specified secret.- Specified by:
listSecretVersions
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecrets
public ListSecretsResponse listSecrets(ListSecretsRequest request)
Description copied from interface:Vaults
Lists all secrets in the specified vault and compartment.- Specified by:
listSecrets
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
rotateSecret
public RotateSecretResponse rotateSecret(RotateSecretRequest request)
Description copied from interface:Vaults
API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object- Specified by:
rotateSecret
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scheduleSecretDeletion
public ScheduleSecretDeletionResponse scheduleSecretDeletion(ScheduleSecretDeletionRequest request)
Description copied from interface:Vaults
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.- Specified by:
scheduleSecretDeletion
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scheduleSecretVersionDeletion
public ScheduleSecretVersionDeletionResponse scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request)
Description copied from interface:Vaults
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
.- Specified by:
scheduleSecretVersionDeletion
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecret
public UpdateSecretResponse updateSecret(UpdateSecretRequest request)
Description copied from interface:Vaults
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.
- Specified by:
updateSecret
in interfaceVaults
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public VaultsWaiters getWaiters()
Description copied from interface:Vaults
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceVaults
- Returns:
- The service waiters.
-
newWaiters
public VaultsWaiters newWaiters(WorkRequest workRequestClient)
Description copied from interface:Vaults
Creates a new VaultsWaiters for resources for this service.- Specified by:
newWaiters
in interfaceVaults
- Parameters:
workRequestClient
- The work request service client used to query for work request status- Returns:
- The service waiters.
-
getPaginators
public VaultsPaginators getPaginators()
Description copied from interface:Vaults
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.- Specified by:
getPaginators
in interfaceVaults
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-