Package com.oracle.bmc.multicloud

Class MetadataClient

    • Field Detail

      • SERVICE

        public static final Service SERVICE
        Service instance for Metadata.

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

    • Method Detail

      • setRegion

        public void setRegion​(Region region)
        Description copied from interface: Metadata
        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 Metadata
        Parameters:
        region - The region of the service.

      • setRegion

        public void setRegion​(String regionId)
        Description copied from interface: Metadata
        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 Metadata
        Parameters:
        regionId - The public region ID.

      • listExternalLocationDetailsMetadata

        public ListExternalLocationDetailsMetadataResponse listExternalLocationDetailsMetadata​(ListExternalLocationDetailsMetadataRequest request)
        Description copied from interface: Metadata
        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" } ]

        Specified by:
        listExternalLocationDetailsMetadata in interface Metadata
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • listExternalLocationMappingMetadata

        public ListExternalLocationMappingMetadataResponse listExternalLocationMappingMetadata​(ListExternalLocationMappingMetadataRequest request)
        Description copied from interface: Metadata
        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" } ]

        Specified by:
        listExternalLocationMappingMetadata in interface Metadata
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • listExternalLocationSummariesMetadata

        public ListExternalLocationSummariesMetadataResponse listExternalLocationSummariesMetadata​(ListExternalLocationSummariesMetadataRequest request)
        Description copied from interface: Metadata
        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", } ]

        Specified by:
        listExternalLocationSummariesMetadata in interface Metadata
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • getPaginators

        public MetadataPaginators getPaginators()
        Description copied from interface: Metadata
        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.

        Specified by:
        getPaginators in interface Metadata
        Returns:
        The service paginators.

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

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()

      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()