@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public class VaultsClient extends BaseSyncClient implements Vaults
Modifier and Type | Class and Description |
---|---|
static class |
VaultsClient.Builder
Builder class for this client.
|
Modifier and Type | Field and 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 and Description |
---|
VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and 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 backing
HttpClient . |
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 object
|
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) |
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.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Vaults.
protected final ExecutorService executorService
public final String clientCommonLibraryVersion
@Deprecated public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.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)
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.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
@Deprecated public VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VaultsClient.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
public static VaultsClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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 call setEndpoint
.
public CancelSecretDeletionResponse cancelSecretDeletion(CancelSecretDeletionRequest request)
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.
cancelSecretDeletion
in interface Vaults
request
- The request object containing the details to sendpublic CancelSecretRotationResponse cancelSecretRotation(CancelSecretRotationRequest request)
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.
cancelSecretRotation
in interface Vaults
request
- The request object containing the details to sendpublic CancelSecretVersionDeletionResponse cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request)
Vaults
Cancels the scheduled deletion of a secret version.
cancelSecretVersionDeletion
in interface Vaults
request
- The request object containing the details to sendpublic ChangeSecretCompartmentResponse changeSecretCompartment(ChangeSecretCompartmentRequest request)
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.
changeSecretCompartment
in interface Vaults
request
- The request object containing the details to sendpublic CreateSecretResponse createSecret(CreateSecretRequest request)
Vaults
Creates a new secret according to the details of the request.
This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.
createSecret
in interface Vaults
request
- The request object containing the details to sendpublic GetSecretResponse getSecret(GetSecretRequest request)
Vaults
Gets information about the specified secret.
public GetSecretVersionResponse getSecretVersion(GetSecretVersionRequest request)
Vaults
Gets information about the specified version of a secret.
getSecretVersion
in interface Vaults
request
- The request object containing the details to sendpublic ListSecretVersionsResponse listSecretVersions(ListSecretVersionsRequest request)
Vaults
Lists all secret versions for the specified secret.
listSecretVersions
in interface Vaults
request
- The request object containing the details to sendpublic ListSecretsResponse listSecrets(ListSecretsRequest request)
Vaults
Lists all secrets in the specified vault and compartment.
listSecrets
in interface Vaults
request
- The request object containing the details to sendpublic RotateSecretResponse rotateSecret(RotateSecretRequest request)
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
rotateSecret
in interface Vaults
request
- The request object containing the details to sendpublic ScheduleSecretDeletionResponse scheduleSecretDeletion(ScheduleSecretDeletionRequest request)
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.
scheduleSecretDeletion
in interface Vaults
request
- The request object containing the details to sendpublic ScheduleSecretVersionDeletionResponse scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request)
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
.
scheduleSecretVersionDeletion
in interface Vaults
request
- The request object containing the details to sendpublic UpdateSecretResponse updateSecret(UpdateSecretRequest request)
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.
updateSecret
in interface Vaults
request
- The request object containing the details to sendpublic VaultsWaiters getWaiters()
Vaults
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Vaults
public VaultsWaiters newWaiters(WorkRequest workRequestClient)
Vaults
Creates a new VaultsWaiters
for resources for this service.
newWaiters
in interface Vaults
workRequestClient
- The work request service client used to query for work request
statuspublic VaultsPaginators getPaginators()
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.
getPaginators
in interface Vaults
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.