@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public class KmsVaultAsyncClient extends Object implements KmsVaultAsync
Async client implementation for KmsVault service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an 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.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
Modifier and Type | Class and Description |
---|---|
static class |
KmsVaultAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for KmsVault.
|
Constructor and Description |
---|
KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsVaultAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsVaultAsyncClient(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.
|
KmsVaultAsyncClient(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.
|
KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsVaultAsyncClient(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 KmsVault.
public KmsVaultAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public KmsVaultAsyncClient(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 KmsVaultAsyncClient(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 KmsVaultAsyncClient(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 KmsVaultAsyncClient(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 KmsVaultAsyncClient(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 KmsVaultAsyncClient(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 static KmsVaultAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
KmsVaultAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface KmsVaultAsync
endpoint
- The endpoint of the serice.public void setRegion(Region region)
KmsVaultAsync
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
in interface KmsVaultAsync
region
- The region of the service.public void setRegion(String regionId)
KmsVaultAsync
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
.
setRegion
in interface KmsVaultAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<CancelVaultDeletionResponse> cancelVaultDeletion(CancelVaultDeletionRequest request, AsyncHandler<CancelVaultDeletionRequest,CancelVaultDeletionResponse> handler)
KmsVaultAsync
Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion restores the vault and all keys in it to the respective states they were in before the deletion was scheduled.
cancelVaultDeletion
in interface KmsVaultAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateVaultResponse> createVault(CreateVaultRequest request, AsyncHandler<CreateVaultRequest,CreateVaultResponse> handler)
KmsVaultAsync
Creates a new vault. The type of vault you create determines key placement, pricing, and available options. Options include storage isolation, a dedicated service endpoint instead of a shared service endpoint for API calls, and a dedicated hardware security module (HSM) or a multitenant HSM.
createVault
in interface KmsVaultAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVaultResponse> getVault(GetVaultRequest request, AsyncHandler<GetVaultRequest,GetVaultResponse> handler)
KmsVaultAsync
Gets the specified vault’s configuration information.
getVault
in interface KmsVaultAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListVaultsResponse> listVaults(ListVaultsRequest request, AsyncHandler<ListVaultsRequest,ListVaultsResponse> handler)
KmsVaultAsync
Lists the vaults in the specified compartment.
listVaults
in interface KmsVaultAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ScheduleVaultDeletionResponse> scheduleVaultDeletion(ScheduleVaultDeletionRequest request, AsyncHandler<ScheduleVaultDeletionRequest,ScheduleVaultDeletionResponse> handler)
KmsVaultAsync
Schedules the deletion of the specified vault. This sets the state of the vault and all keys in it to PENDING_DELETION
and then deletes them after the retention period ends.
scheduleVaultDeletion
in interface KmsVaultAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateVaultResponse> updateVault(UpdateVaultRequest request, AsyncHandler<UpdateVaultRequest,UpdateVaultResponse> handler)
KmsVaultAsync
Updates the properties of a vault. Specifically, you can update the displayName
, freeformTags
, and definedTags
properties. Furthermore, the vault must be in an ACTIVE
or CREATING
state to be updated.
updateVault
in interface KmsVaultAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2019. All rights reserved.