Package com.oracle.bmc.multicloud

Interface Metadata

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    MetadataClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public interface Metadata
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 Oracle Multicloud Hub. 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

      • listExternalLocationDetailsMetadata

        ListExternalLocationDetailsMetadataResponse listExternalLocationDetailsMetadata​(ListExternalLocationDetailsMetadataRequest request)
        List externalLocationDetail metadata from OCI to Cloud Service Provider for regions, Availability Zones, and Cluster Placement Group 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/multicloud/ListExternalLocationDetailsMetadataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExternalLocationDetailsMetadata API.

      • listExternalLocationMappingMetadata

        ListExternalLocationMappingMetadataResponse listExternalLocationMappingMetadata​(ListExternalLocationMappingMetadataRequest request)
        List mapped partner cloud regions and zones across cloud service providers for the specified Multicloud base compartment and subscription service name.

        Each mapping includes the OCI region, logical availability domain, and physical availability domain, along with mapped partner cloud details that depend on the partner cloud. For example, Azure includes a logical zone while AWS doesn’t. For more information, see Cross-Cloud Region-Zone Mapping.

        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/multicloud/ListExternalLocationMappingMetadataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExternalLocationMappingMetadata API.

      • listExternalLocationSummariesMetadata

        ListExternalLocationSummariesMetadataResponse listExternalLocationSummariesMetadata​(ListExternalLocationSummariesMetadataRequest request)
        List externalLocationSummary metadata from OCI Region to the Cloud Service Provider region across all regions.
        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/multicloud/ListExternalLocationSummariesMetadataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExternalLocationSummariesMetadata API.

      • getPaginators

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