Package com.oracle.bmc.multicloud

Interface MetadataAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    MetadataAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public interface MetadataAsync
extends AutoCloseable
    Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider.

    For more information, see .

    • 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

      • listExternalLocationDetailsMetadata

        Future<ListExternalLocationDetailsMetadataResponse> listExternalLocationDetailsMetadata​(ListExternalLocationDetailsMetadataRequest request,
                                                                                        AsyncHandler<ListExternalLocationDetailsMetadataRequest,​ListExternalLocationDetailsMetadataResponse> handler)
        List externalLocationDetail metadata from OCI to Cloud Service Provider for regions, Availability Zones, and Cluster Placement Group ID.

        examples: application-json: | [ { "externalLocation": { "cspRegion": "East US", "cspPhysicalAz": "az1-xyz", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az1", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-1 or aws-account-id-1, gcp-project-id-1" } }, "ociPhysicalAd": "ad1-xyb", "ociLogicalAd": "ad2", "ociRegion": "us-ashburn-1", "cpgId": "cpg-1" }, { "externalLocation": { "cspRegion": "East US", "cspPhysicalAz": "az2-abc", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az2", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-2 or aws-account-id-2, gcp-project-id-2" } }, "ociPhysicalAd": "ad2-xby", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1", "cpgId": "cpg-2" }, { "externalLocation": { "cspRegion": "East US", "cspPhysicalAz": "az3-abz", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az3", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3" } }, "ociPhysicalAd": "ad3-cde", "ociLogicalAd": "ad3", "ociRegion": "us-ashburn-1", "cpgId": "cpg-3" }, { "externalLocation": { "cspRegion": "East US 2", "cspPhysicalAz": "az1-def", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az1", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-4 or aws-account-id-4, gcp-project-id-4" } }, "ociPhysicalAd": "ad1-bce", "ociLogicalAd": "ad2", "ociRegion": "us-ashburn-1", "cpgId": "cpg-4" }, { "externalLocation": { "cspRegion": "East US 2", "cspPhysicalAz": "az2-uvw", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az2", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3" } }, "ociPhysicalAd": "ad2-ftc", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1", "cpgId": "cpg-5" }, { "externalLocation": { "cspRegion": "East US 2", "cspPhysicalAz": "az3-uvw", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az3", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3" } }, "ociPhysicalAd": "ad3-stc", "ociLogicalAd": "ad3", "ociRegion": "us-ashburn-1", "cpgId": "cpg-6" } ]

        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.

      • listExternalLocationMappingMetadata

        Future<ListExternalLocationMappingMetadataResponse> listExternalLocationMappingMetadata​(ListExternalLocationMappingMetadataRequest request,
                                                                                        AsyncHandler<ListExternalLocationMappingMetadataRequest,​ListExternalLocationMappingMetadataResponse> handler)
        List externalLocation metadata from OCI to the Cloud Service Provider for regions, Physical Availability Zones.

        examples: application-json: | [ { "externalLocation": { "cspRegion": "eastus", "cspPhysicalAz": "eastus-az1", "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-1", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "eastus", "cspPhysicalAz": "eastus-az1", "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-1", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "eastus2", "cspPhysicalAz": "eastus2-az3", "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-2", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "eastus", "cspPhysicalAz": "eastus-az3" "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-333", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" } ]

        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.

      • listExternalLocationSummariesMetadata

        Future<ListExternalLocationSummariesMetadataResponse> listExternalLocationSummariesMetadata​(ListExternalLocationSummariesMetadataRequest request,
                                                                                            AsyncHandler<ListExternalLocationSummariesMetadataRequest,​ListExternalLocationSummariesMetadataResponse> handler)
        List externalLocationSummary metadata from OCI Region to the Cloud Service Provider region across all regions.

        examples: application-json: | [ { "externalLocation": { "cspRegion": "East US" }, "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "East US 2" }, "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "Germany West Central" }, "ociRegion": "eu-frankfurt-1", } ]

        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.