java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.keymanagement.KmsHsmClusterAsyncClient

All Implemented Interfaces:

KmsHsmClusterAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public class KmsHsmClusterAsyncClient
extends BaseAsyncClient
implements KmsHsmClusterAsync
```
Async client implementation for KmsHsmCluster 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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class KmsHsmClusterAsyncClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for KmsHsmCluster.

Constructor Summary

Constructors
Constructor	Description
`KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`KmsHsmClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`KmsHsmClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`KmsHsmClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KmsHsmClusterAsyncClient.Builder`	`builder()`	Create a builder for this client.
`Future<CancelHsmClusterDeletionResponse>`	`cancelHsmClusterDeletion(CancelHsmClusterDeletionRequest request, AsyncHandler<CancelHsmClusterDeletionRequest,CancelHsmClusterDeletionResponse> handler)`	Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
`Future<ChangeHsmClusterCompartmentResponse>`	`changeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest request, AsyncHandler<ChangeHsmClusterCompartmentRequest,ChangeHsmClusterCompartmentResponse> handler)`	Moves a HSM Cluster resource to a different compartment within the same tenancy.
`protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>`	`clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)`
`void`	`close()`
`Future<CreateHsmClusterResponse>`	`createHsmCluster(CreateHsmClusterRequest request, AsyncHandler<CreateHsmClusterRequest,CreateHsmClusterResponse> handler)`	Creates a new HSM cluster resource.
`Future<DownloadCertificateSigningRequestResponse>`	`downloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest request, AsyncHandler<DownloadCertificateSigningRequestRequest,DownloadCertificateSigningRequestResponse> handler)`	Retrieves the certificate signing request for the designated HSM Cluster resource.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`	Get the endpoint of the client.
`Future<GetHsmClusterResponse>`	`getHsmCluster(GetHsmClusterRequest request, AsyncHandler<GetHsmClusterRequest,GetHsmClusterResponse> handler)`	Retrieves configuration details for the specified HSM Cluster resource.
`Future<GetHsmPartitionResponse>`	`getHsmPartition(GetHsmPartitionRequest request, AsyncHandler<GetHsmPartitionRequest,GetHsmPartitionResponse> handler)`	Retrieves HSM partition details for the specified HSM cluster.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`Future<GetPreCoUserCredentialsResponse>`	`getPreCoUserCredentials(GetPreCoUserCredentialsRequest request, AsyncHandler<GetPreCoUserCredentialsRequest,GetPreCoUserCredentialsResponse> handler)`	Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`Future<ListHsmClustersResponse>`	`listHsmClusters(ListHsmClustersRequest request, AsyncHandler<ListHsmClustersRequest,ListHsmClustersResponse> handler)`	Lists all HSM cluster resources contained within the specified compartment.
`Future<ListHsmPartitionsResponse>`	`listHsmPartitions(ListHsmPartitionsRequest request, AsyncHandler<ListHsmPartitionsRequest,ListHsmPartitionsResponse> handler)`	Lists all HSM partitions within the specified HSM Cluster resource.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`Future<ScheduleHsmClusterDeletionResponse>`	`scheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest request, AsyncHandler<ScheduleHsmClusterDeletionRequest,ScheduleHsmClusterDeletionResponse> handler)`	Schedules HSM cluster for deletion, update its lifecycle state to ‘PENDING_DELETION’ and deletes it after the retention period.
`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’).
`Future<UpdateHsmClusterResponse>`	`updateHsmCluster(UpdateHsmClusterRequest request, AsyncHandler<UpdateHsmClusterRequest,UpdateHsmClusterResponse> handler)`	Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`.
`Future<UploadPartitionCertificatesResponse>`	`uploadPartitionCertificates(UploadPartitionCertificatesRequest request, AsyncHandler<UploadPartitionCertificatesRequest,UploadPartitionCertificatesResponse> handler)`	Uploads the partition owner certificates to the HSM Cluster resource.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.keymanagement.KmsHsmClusterAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for KmsHsmCluster.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - KmsHsmClusterAsyncClient
```
@Deprecated
public KmsHsmClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KmsHsmClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - KmsHsmClusterAsyncClient
```
@Deprecated
public KmsHsmClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KmsHsmClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - KmsHsmClusterAsyncClient
```
@Deprecated
public KmsHsmClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KmsHsmClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - KmsHsmClusterAsyncClient
```
@Deprecated
public KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KmsHsmClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - KmsHsmClusterAsyncClient
```
@Deprecated
public KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KmsHsmClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - KmsHsmClusterAsyncClient
```
@Deprecated
public KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KmsHsmClusterAsyncClient.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)
  - KmsHsmClusterAsyncClient
```
@Deprecated
public KmsHsmClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KmsHsmClusterAsyncClient.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
- Method Detail
  - builder
```
public static KmsHsmClusterAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: KmsHsmClusterAsync
    
    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.
    
    Specified by:
    
    setRegion in interface KmsHsmClusterAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: KmsHsmClusterAsync
    
    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.
    
    Specified by:
    
    setRegion in interface KmsHsmClusterAsync
    
    Parameters:
    
    regionId - The public region ID.
  - cancelHsmClusterDeletion
```
public Future<CancelHsmClusterDeletionResponse> cancelHsmClusterDeletion(CancelHsmClusterDeletionRequest request,
                                                                         AsyncHandler<CancelHsmClusterDeletionRequest,CancelHsmClusterDeletionResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
    
    Specified by:
    
    cancelHsmClusterDeletion in interface KmsHsmClusterAsync
    
    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.
  - changeHsmClusterCompartment
```
public Future<ChangeHsmClusterCompartmentResponse> changeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest request,
                                                                               AsyncHandler<ChangeHsmClusterCompartmentRequest,ChangeHsmClusterCompartmentResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Moves a HSM Cluster resource to a different compartment within the same tenancy.
    
    Specified by:
    
    changeHsmClusterCompartment in interface KmsHsmClusterAsync
    
    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.
  - createHsmCluster
```
public Future<CreateHsmClusterResponse> createHsmCluster(CreateHsmClusterRequest request,
                                                         AsyncHandler<CreateHsmClusterRequest,CreateHsmClusterResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Creates a new HSM cluster resource.
    
    Specified by:
    
    createHsmCluster in interface KmsHsmClusterAsync
    
    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.
  - downloadCertificateSigningRequest
```
public Future<DownloadCertificateSigningRequestResponse> downloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest request,
                                                                                           AsyncHandler<DownloadCertificateSigningRequestRequest,DownloadCertificateSigningRequestResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Retrieves the certificate signing request for the designated HSM Cluster resource.
    
    Specified by:
    
    downloadCertificateSigningRequest in interface KmsHsmClusterAsync
    
    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.
  - getHsmCluster
```
public Future<GetHsmClusterResponse> getHsmCluster(GetHsmClusterRequest request,
                                                   AsyncHandler<GetHsmClusterRequest,GetHsmClusterResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Retrieves configuration details for the specified HSM Cluster resource.
    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.
    
    Specified by:
    
    getHsmCluster in interface KmsHsmClusterAsync
    
    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.
  - getHsmPartition
```
public Future<GetHsmPartitionResponse> getHsmPartition(GetHsmPartitionRequest request,
                                                       AsyncHandler<GetHsmPartitionRequest,GetHsmPartitionResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Retrieves HSM partition details for the specified HSM cluster.
    
    Specified by:
    
    getHsmPartition in interface KmsHsmClusterAsync
    
    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.
  - getPreCoUserCredentials
```
public Future<GetPreCoUserCredentialsResponse> getPreCoUserCredentials(GetPreCoUserCredentialsRequest request,
                                                                       AsyncHandler<GetPreCoUserCredentialsRequest,GetPreCoUserCredentialsResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.
    
    Specified by:
    
    getPreCoUserCredentials in interface KmsHsmClusterAsync
    
    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.
  - listHsmClusters
```
public Future<ListHsmClustersResponse> listHsmClusters(ListHsmClustersRequest request,
                                                       AsyncHandler<ListHsmClustersRequest,ListHsmClustersResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Lists all HSM cluster resources contained within the specified compartment.
    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.
    
    Specified by:
    
    listHsmClusters in interface KmsHsmClusterAsync
    
    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.
  - listHsmPartitions
```
public Future<ListHsmPartitionsResponse> listHsmPartitions(ListHsmPartitionsRequest request,
                                                           AsyncHandler<ListHsmPartitionsRequest,ListHsmPartitionsResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Lists all HSM partitions within the specified HSM Cluster resource.
    
    Specified by:
    
    listHsmPartitions in interface KmsHsmClusterAsync
    
    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.
  - scheduleHsmClusterDeletion
```
public Future<ScheduleHsmClusterDeletionResponse> scheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest request,
                                                                             AsyncHandler<ScheduleHsmClusterDeletionRequest,ScheduleHsmClusterDeletionResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Schedules HSM cluster for deletion, update its lifecycle state to ‘PENDING_DELETION’ and deletes it after the retention period.
    
    Specified by:
    
    scheduleHsmClusterDeletion in interface KmsHsmClusterAsync
    
    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.
  - updateHsmCluster
```
public Future<UpdateHsmClusterResponse> updateHsmCluster(UpdateHsmClusterRequest request,
                                                         AsyncHandler<UpdateHsmClusterRequest,UpdateHsmClusterResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Modifies properties of an HSM cluster resource, including displayName, freeformTags and definedTags.
    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
    
    Specified by:
    
    updateHsmCluster in interface KmsHsmClusterAsync
    
    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.
  - uploadPartitionCertificates
```
public Future<UploadPartitionCertificatesResponse> uploadPartitionCertificates(UploadPartitionCertificatesRequest request,
                                                                               AsyncHandler<UploadPartitionCertificatesRequest,UploadPartitionCertificatesResponse> handler)
```
    Description copied from interface: KmsHsmClusterAsync
    
    Uploads the partition owner certificates to the HSM Cluster resource.
    
    Specified by:
    
    uploadPartitionCertificates in interface KmsHsmClusterAsync
    
    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.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)
```

Class KmsHsmClusterAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.keymanagement.KmsHsmClusterAsync

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

KmsHsmClusterAsyncClient

KmsHsmClusterAsyncClient

KmsHsmClusterAsyncClient

KmsHsmClusterAsyncClient

KmsHsmClusterAsyncClient

KmsHsmClusterAsyncClient

KmsHsmClusterAsyncClient

Method Detail

builder

setRegion

setRegion

cancelHsmClusterDeletion

changeHsmClusterCompartment

createHsmCluster

downloadCertificateSigningRequest

getHsmCluster

getHsmPartition

getPreCoUserCredentials

listHsmClusters

listHsmPartitions

scheduleHsmClusterDeletion

updateHsmCluster

uploadPartitionCertificates

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient

clientCall