com.oracle.bmc.secrets

Interface SecretsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SecretsAsyncClient

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

Use the Secret Retrieval API to retrieve secrets and secret versions from vaults. For more information, see Managing Secrets.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetSecretBundleResponse>	getSecretBundle(GetSecretBundleRequest request, AsyncHandler<GetSecretBundleRequest,GetSecretBundleResponse> handler) Gets a secret bundle that matches either the specified stage, secretVersionName, or versionNumber parameter.
Future<GetSecretBundleByNameResponse>	getSecretBundleByName(GetSecretBundleByNameRequest request, AsyncHandler<GetSecretBundleByNameRequest,GetSecretBundleByNameResponse> handler) Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter.
Future<ListSecretBundleVersionsResponse>	listSecretBundleVersions(ListSecretBundleVersionsRequest request, AsyncHandler<ListSecretBundleVersionsRequest,ListSecretBundleVersionsResponse> handler) Lists all secret bundle versions for the specified secret.
void	refreshClient() Rebuilds the client from scratch.
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’).
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

getSecretBundle

Future<GetSecretBundleResponse> getSecretBundle(GetSecretBundleRequest request,
                                                AsyncHandler<GetSecretBundleRequest,GetSecretBundleResponse> handler)

Gets a secret bundle that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT will be returned.

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.

getSecretBundleByName

Future<GetSecretBundleByNameResponse> getSecretBundleByName(GetSecretBundleByNameRequest request,
                                                            AsyncHandler<GetSecretBundleByNameRequest,GetSecretBundleByNameResponse> handler)

Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT is returned.

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.

listSecretBundleVersions

Future<ListSecretBundleVersionsResponse> listSecretBundleVersions(ListSecretBundleVersionsRequest request,
                                                                  AsyncHandler<ListSecretBundleVersionsRequest,ListSecretBundleVersionsResponse> handler)

Lists all secret bundle 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.