@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public class VaultsAsyncClient extends Object implements VaultsAsync
Async client implementation for Vaults service.
There are two ways to use async client:
InputStream, like
getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else,
because the stream will be closed right after the AsyncHandler is invoked. | Modifier and Type | Class and Description |
|---|---|
static class |
VaultsAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for Vaults.
|
| Constructor and Description |
|---|
VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for Vaults.
public VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public VaultsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static VaultsAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
VaultsAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface VaultsAsyncendpoint - The endpoint of the serice.public String getEndpoint()
VaultsAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface VaultsAsyncpublic void setRegion(Region region)
VaultsAsyncSets 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 in interface VaultsAsyncregion - The region of the service.public void setRegion(String regionId)
VaultsAsyncSets 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.
setRegion in interface VaultsAsyncregionId - The public region ID.public void close()
close in interface AutoCloseablepublic Future<CancelSecretDeletionResponse> cancelSecretDeletion(CancelSecretDeletionRequest request, AsyncHandler<CancelSecretDeletionRequest,CancelSecretDeletionResponse> handler)
VaultsAsyncCancels 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 VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CancelSecretVersionDeletionResponse> cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request, AsyncHandler<CancelSecretVersionDeletionRequest,CancelSecretVersionDeletionResponse> handler)
VaultsAsyncCancels the scheduled deletion of a secret version.
cancelSecretVersionDeletion in interface VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeSecretCompartmentResponse> changeSecretCompartment(ChangeSecretCompartmentRequest request, AsyncHandler<ChangeSecretCompartmentRequest,ChangeSecretCompartmentResponse> handler)
VaultsAsyncMoves 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 VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateSecretResponse> createSecret(CreateSecretRequest request, AsyncHandler<CreateSecretRequest,CreateSecretResponse> handler)
VaultsAsyncCreates 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 VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetSecretResponse> getSecret(GetSecretRequest request, AsyncHandler<GetSecretRequest,GetSecretResponse> handler)
VaultsAsyncGets information about the specified secret.
getSecret in interface VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetSecretVersionResponse> getSecretVersion(GetSecretVersionRequest request, AsyncHandler<GetSecretVersionRequest,GetSecretVersionResponse> handler)
VaultsAsyncGets information about the specified version of a secret.
getSecretVersion in interface VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListSecretVersionsResponse> listSecretVersions(ListSecretVersionsRequest request, AsyncHandler<ListSecretVersionsRequest,ListSecretVersionsResponse> handler)
VaultsAsyncLists all secret versions for the specified secret.
listSecretVersions in interface VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListSecretsResponse> listSecrets(ListSecretsRequest request, AsyncHandler<ListSecretsRequest,ListSecretsResponse> handler)
VaultsAsyncLists all secrets in the specified vault and compartment.
listSecrets in interface VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ScheduleSecretDeletionResponse> scheduleSecretDeletion(ScheduleSecretDeletionRequest request, AsyncHandler<ScheduleSecretDeletionRequest,ScheduleSecretDeletionResponse> handler)
VaultsAsyncSchedules 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 VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ScheduleSecretVersionDeletionResponse> scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request, AsyncHandler<ScheduleSecretVersionDeletionRequest,ScheduleSecretVersionDeletionResponse> handler)
VaultsAsyncSchedules 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 VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateSecretResponse> updateSecret(UpdateSecretRequest request, AsyncHandler<UpdateSecretRequest,UpdateSecretResponse> handler)
VaultsAsyncUpdates 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 VaultsAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.