com.oracle.bmc.vault

Interface VaultsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

VaultsAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180608")
public interface VaultsAsync
extends AutoCloseable

Use the Secret Management API to manage secrets and secret versions. For more information, see Managing Secrets.

Method Summary

Modifier and Type	Method and Description
Future<CancelSecretDeletionResponse>	cancelSecretDeletion(CancelSecretDeletionRequest request, AsyncHandler<CancelSecretDeletionRequest,CancelSecretDeletionResponse> handler) Cancels the pending deletion of the specified secret.
Future<CancelSecretRotationResponse>	cancelSecretRotation(CancelSecretRotationRequest request, AsyncHandler<CancelSecretRotationRequest,CancelSecretRotationResponse> handler) Cancels the ongoing secret rotation.
Future<CancelSecretVersionDeletionResponse>	cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request, AsyncHandler<CancelSecretVersionDeletionRequest,CancelSecretVersionDeletionResponse> handler) Cancels the scheduled deletion of a secret version.
Future<ChangeSecretCompartmentResponse>	changeSecretCompartment(ChangeSecretCompartmentRequest request, AsyncHandler<ChangeSecretCompartmentRequest,ChangeSecretCompartmentResponse> handler) Moves a secret into a different compartment within the same tenancy.
Future<CreateSecretResponse>	createSecret(CreateSecretRequest request, AsyncHandler<CreateSecretRequest,CreateSecretResponse> handler) 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)
Future<GetSecretResponse>	getSecret(GetSecretRequest request, AsyncHandler<GetSecretRequest,GetSecretResponse> handler) Gets information about the specified secret.
Future<GetSecretVersionResponse>	getSecretVersion(GetSecretVersionRequest request, AsyncHandler<GetSecretVersionRequest,GetSecretVersionResponse> handler) Gets information about the specified version of a secret.
Future<ListSecretsResponse>	listSecrets(ListSecretsRequest request, AsyncHandler<ListSecretsRequest,ListSecretsResponse> handler) Lists all secrets in the specified vault and compartment.
Future<ListSecretVersionsResponse>	listSecretVersions(ListSecretVersionsRequest request, AsyncHandler<ListSecretVersionsRequest,ListSecretVersionsResponse> handler) Lists all secret versions for the specified secret.
void	refreshClient() Rebuilds the client from scratch.
Future<RotateSecretResponse>	rotateSecret(RotateSecretRequest request, AsyncHandler<RotateSecretRequest,RotateSecretResponse> handler) 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
Future<ScheduleSecretDeletionResponse>	scheduleSecretDeletion(ScheduleSecretDeletionRequest request, AsyncHandler<ScheduleSecretDeletionRequest,ScheduleSecretDeletionResponse> handler) Schedules the deletion of the specified secret.
Future<ScheduleSecretVersionDeletionResponse>	scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request, AsyncHandler<ScheduleSecretVersionDeletionRequest,ScheduleSecretVersionDeletionResponse> handler) 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’).
Future<UpdateSecretResponse>	updateSecret(UpdateSecretRequest request, AsyncHandler<UpdateSecretRequest,UpdateSecretResponse> handler) Updates the properties of a secret.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

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.

Parameters:

region - The region of the service.

setRegion

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.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

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”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

cancelSecretDeletion

Future<CancelSecretDeletionResponse> cancelSecretDeletion(CancelSecretDeletionRequest request,
                                                          AsyncHandler<CancelSecretDeletionRequest,CancelSecretDeletionResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

cancelSecretRotation

Future<CancelSecretRotationResponse> cancelSecretRotation(CancelSecretRotationRequest request,
                                                          AsyncHandler<CancelSecretRotationRequest,CancelSecretRotationResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

cancelSecretVersionDeletion

Future<CancelSecretVersionDeletionResponse> cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request,
                                                                        AsyncHandler<CancelSecretVersionDeletionRequest,CancelSecretVersionDeletionResponse> handler)

Cancels the scheduled deletion of a secret version.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeSecretCompartment

Future<ChangeSecretCompartmentResponse> changeSecretCompartment(ChangeSecretCompartmentRequest request,
                                                                AsyncHandler<ChangeSecretCompartmentRequest,ChangeSecretCompartmentResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createSecret

Future<CreateSecretResponse> createSecret(CreateSecretRequest request,
                                          AsyncHandler<CreateSecretRequest,CreateSecretResponse> handler)

Creates a new secret according to the details of the request.

This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSecret

Future<GetSecretResponse> getSecret(GetSecretRequest request,
                                    AsyncHandler<GetSecretRequest,GetSecretResponse> handler)

Gets information about the specified secret.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSecretVersion

Future<GetSecretVersionResponse> getSecretVersion(GetSecretVersionRequest request,
                                                  AsyncHandler<GetSecretVersionRequest,GetSecretVersionResponse> handler)

Gets information about the specified version of a secret.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSecretVersions

Future<ListSecretVersionsResponse> listSecretVersions(ListSecretVersionsRequest request,
                                                      AsyncHandler<ListSecretVersionsRequest,ListSecretVersionsResponse> handler)

Lists all secret versions for the specified secret.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSecrets

Future<ListSecretsResponse> listSecrets(ListSecretsRequest request,
                                        AsyncHandler<ListSecretsRequest,ListSecretsResponse> handler)

Lists all secrets in the specified vault and compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

rotateSecret

Future<RotateSecretResponse> rotateSecret(RotateSecretRequest request,
                                          AsyncHandler<RotateSecretRequest,RotateSecretResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

scheduleSecretDeletion

Future<ScheduleSecretDeletionResponse> scheduleSecretDeletion(ScheduleSecretDeletionRequest request,
                                                              AsyncHandler<ScheduleSecretDeletionRequest,ScheduleSecretDeletionResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

scheduleSecretVersionDeletion

Future<ScheduleSecretVersionDeletionResponse> scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request,
                                                                            AsyncHandler<ScheduleSecretVersionDeletionRequest,ScheduleSecretVersionDeletionResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSecret

Future<UpdateSecretResponse> updateSecret(UpdateSecretRequest request,
                                          AsyncHandler<UpdateSecretRequest,UpdateSecretResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.