Package com.oracle.bmc.dbmulticloud

Interface OracleDbAzureKeyAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OracleDbAzureKeyAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240501")
public interface OracleDbAzureKeyAsync
extends AutoCloseable

    Microsoft Azure:
    Oracle Azure Connector Resource::  The Oracle Azure Connector Resource is used to install the Azure Arc Server on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

    The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster:

    • Using a Bearer Access Token

    Oracle Azure Blob Container Resource:  The Oracle Azure Blob Container Resource is used to capture the details of an Azure Blob Container. This resource can then be reused across multiple Exadata VM clusters in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D) to mount the Azure container.

    Oracle Azure Blob Mount Resource:  The Oracle Azure Blob Mount Resource is used to mount an Azure Blob Container on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D). It relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.

    Discover Azure Vaults and Keys Resource:  The Discover Oracle Azure Vaults and Azure Keys Resource is used to discover Azure Vaults and the associated encryption keys available in your Azure project.

    Oracle Azure Vault:  The Oracle Azure Vault Resource is used to manage Azure Vaults within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

    Oracle Azure Key:  Oracle Azure Key Resource is used to register and manage a Oracle Azure Key Key within Oracle Cloud Infrastructure (OCI) under an associated Azure Vault.
    Google Cloud:
    Oracle Google Cloud Connector Resource:  The Oracle Google Cloud Connector Resource is used to install the Google Cloud Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

    Discover Google Key Rings and Keys Resource:  The Discover Google Key Rings and Keys Resource is used to discover Google Cloud Key Rings and the associated encryption keys available in your Google Cloud project.

    Google Key Rings Resource:  The Google Key Rings Resource is used to register and manage Google Cloud Key Rings within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

    Google Key Resource:  The Google Key Resource is used to register and manage a Google Cloud Key within Oracle Cloud Infrastructure (OCI) under an associated Google Key Ring.

    • 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

      • getOracleDbAzureKey

        Future<GetOracleDbAzureKeyResponse> getOracleDbAzureKey​(GetOracleDbAzureKeyRequest request,
                                                        AsyncHandler<GetOracleDbAzureKeyRequest,​GetOracleDbAzureKeyResponse> handler)
        Retrieves detailed information about a Oracle DB Azure Key resource by specifying its unique resource OCID.
        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.

      • listOracleDbAzureKeys

        Future<ListOracleDbAzureKeysResponse> listOracleDbAzureKeys​(ListOracleDbAzureKeysRequest request,
                                                            AsyncHandler<ListOracleDbAzureKeysRequest,​ListOracleDbAzureKeysResponse> handler)
        Lists all Oracle DB Azure Keys based on the specified filters.
        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.