Package com.oracle.bmc

Interface Service

  • public interface Service
    Interface representing a service definition.

    See Services to create new instances.

    • Method Detail

      • getServiceName

        String getServiceName()
        The unique service name, ex “BLOCKSTORAGE”.

        Must not be null.

      • getServiceEndpointPrefix

        String getServiceEndpointPrefix()
        The service endpoint prefix that will be used, ex “iaas” for “https://iaas.us-phoenix-1.oraclecloud.com”.

      • getServiceEndpointTemplate

        String getServiceEndpointTemplate()
        The service endpoint template that will be used, ex “{serviceEndpointPrefix}.{region}.service.oci.oraclecloud.com”.

        This overrides the template used in DefaultEndpointConfiguration, but can still use the same variables.

      • getServiceEndpointTemplateForRealmMap

        Map<String,​String> getServiceEndpointTemplateForRealmMap()
        The map of all realm-specific service endpoint templates with realmId as key and endpoint template for corresponding realmId as the value ex “oc1={serviceParameter}{serviceEndpointPrefix}.{region}.{serviceSecondLevelDomain}”.

        This overrides the template used in DefaultEndpointConfiguration, but can still use the same variables.

      • addServiceEndpointTemplateForRealm

        void addServiceEndpointTemplateForRealm​(String realmId,
                                        String endpoint)
        This method adds service endpoint templates for the realm to a map
        Parameters:
        realmId - Key in the map
        endpoint - Value in the map

      • getEndpointServiceName

        String getEndpointServiceName()
        The service endpoint name that will be used only for dotted regions if set by the service.

        {service} in “https://{service}.{region}”. The service endpoint template (if specified) will be ignored in this case.