Top Description Methods
com.oracle.bmc

public Interface Service

Known Direct Implementers
com.oracle.bmc.Services.BasicService
Annotations
@InternalSdk
Imports
java.util.Map
Interface representing a service definition.

See Services to create new instances.

Method Summary

Modifier and TypeMethod and Description
public void
addServiceEndpointTemplateForRealm(String
Key in the map
realmId, String
Value in the map
endpoint)

This method adds service endpoint templates for the realm to a map

public String
getEndpointServiceName()

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

public String
getServiceEndpointPrefix()

The service endpoint prefix that will be used, ex "iaas" for "https://iaas.us-phoenix-1.oraclecloud.com".

public String
getServiceEndpointTemplate()

The service endpoint template that will be used, ex "{serviceEndpointPrefix}.{region}.service.oci.oraclecloud.com".

public 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}".

public String
getServiceName()

The unique service name, ex "BLOCKSTORAGE".

Method Detail

addServiceEndpointTemplateForRealmback to summary
public void addServiceEndpointTemplateForRealm(String realmId, String endpoint)

This method adds service endpoint templates for the realm to a map

Parameters
realmId:String

Key in the map

endpoint:String

Value in the map

getEndpointServiceNameback to summary
public 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.

getServiceEndpointPrefixback to summary
public String getServiceEndpointPrefix()

The service endpoint prefix that will be used, ex "iaas" for "https://iaas.us-phoenix-1.oraclecloud.com".

getServiceEndpointTemplateback to summary
public 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.

getServiceEndpointTemplateForRealmMapback to summary
public 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.

getServiceNameback to summary
public String getServiceName()

The unique service name, ex "BLOCKSTORAGE". Must not be null.