Package com.oracle.bmc.dbmulticloud

Interface OracleDBAzureConnector

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

    Oracle Azure Connector Resource: This is for installing Azure Arc Server in ExaCS VM Cluster. There are two way to install Azure Arc Server (Azure Identity) in ExaCS VMCluster. a. Using Bearer Access Token or b. By providing Authentication token

    2. Oracle Azure Blob Container Resource: This is for to capture Azure Container details and same will be used in multiple ExaCS VMCluster to mount the Azure Container.

    3. Oracle Azure Blob Mount Resource: This is for to mount Azure Container in ExaCS VMCluster using Oracle Azure Connector and Oracle Azure Blob Container Resource.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • 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 service.

      • 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

      • changeOracleDbAzureConnectorCompartment

        ChangeOracleDbAzureConnectorCompartmentResponse changeOracleDbAzureConnectorCompartment​(ChangeOracleDbAzureConnectorCompartmentRequest request)
        Moves the Oracle DB Azure Connector Resource into a different compartment.

        When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/ChangeOracleDbAzureConnectorCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeOracleDbAzureConnectorCompartment API.

      • createOracleDbAzureConnector

        CreateOracleDbAzureConnectorResponse createOracleDbAzureConnector​(CreateOracleDbAzureConnectorRequest request)
        Creates Oracle DB Azure Connector Resource and configured Azure Identity in OCI Database Resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/CreateOracleDbAzureConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOracleDbAzureConnector API.

      • deleteOracleDbAzureConnector

        DeleteOracleDbAzureConnectorResponse deleteOracleDbAzureConnector​(DeleteOracleDbAzureConnectorRequest request)
        Delete Oracle DB Azure Connector Resource and delete Azure Arc Identity too from Database Resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/DeleteOracleDbAzureConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOracleDbAzureConnector API.

      • getOracleDbAzureConnector

        GetOracleDbAzureConnectorResponse getOracleDbAzureConnector​(GetOracleDbAzureConnectorRequest request)
        Get Oracle DB Azure Connector Resource form a particular Resource ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/GetOracleDbAzureConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOracleDbAzureConnector API.

      • listOracleDbAzureConnectors

        ListOracleDbAzureConnectorsResponse listOracleDbAzureConnectors​(ListOracleDbAzureConnectorsRequest request)
        Lists the all Oracle DB Azure Connector Resource based on filters.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/ListOracleDbAzureConnectorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOracleDbAzureConnectors API.

      • patchOracleDbAzureConnector

        PatchOracleDbAzureConnectorResponse patchOracleDbAzureConnector​(PatchOracleDbAzureConnectorRequest request)
        Patch Azure Arc Agent on VM Cluster with new version.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/PatchOracleDbAzureConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PatchOracleDbAzureConnector API.

      • updateOracleDbAzureConnector

        UpdateOracleDbAzureConnectorResponse updateOracleDbAzureConnector​(UpdateOracleDbAzureConnectorRequest request)
        Modifies the existing Oracle DB Azure Connector Resource for a given ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/UpdateOracleDbAzureConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOracleDbAzureConnector API.

      • getWaiters

        OracleDBAzureConnectorWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        OracleDBAzureConnectorPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.