com.ibm.cloud.objectstorage.regions

Interface RegionImpl

All Known Implementing Classes:

InMemoryRegionImpl, PartitionRegionImpl

public interface RegionImpl

Interface for an region implementation.

Method Summary

Modifier and Type	Method and Description
Collection<String>	getAvailableEndpoints() Returns an immutable collection of all the endpoints available in the region metadata.
String	getDomain() Returns the domain for this region; ex: "amazonaws.com".
String	getName() The unique system ID for this region; ex: "us-east-1".
String	getPartition() Returns the partition this region is in.
String	getServiceEndpoint(String serviceName) Returns the endpoint for the service given.
boolean	hasHttpEndpoint(String serviceName) Returns whether the given service support the http protocol in this region.
boolean	hasHttpsEndpoint(String serviceName) Returns whether the given service support the https protocol in this region.
boolean	isServiceSupported(String serviceName) Returns whether the given service is supported in this region.

Method Detail

getName

String getName()

The unique system ID for this region; ex: "us-east-1".

Returns:

The unique system ID for this region.

getDomain

String getDomain()

Returns the domain for this region; ex: "amazonaws.com".

Returns:

The domain for this region.

getPartition

String getPartition()

Returns the partition this region is in. I.E. 'aws' or 'aws-cn'

Returns:

The partition this region is in.

isServiceSupported

boolean isServiceSupported(String serviceName)

Returns whether the given service is supported in this region.

Parameters:

serviceName - The service endpoint prefix which can be retrieved from the constant ENDPOINT_PREFIX of the specific service client interface, e.g. AmazonEC2.ENDPOINT_PREFIX.

getServiceEndpoint

String getServiceEndpoint(String serviceName)

Returns the endpoint for the service given.

Parameters:

serviceName - The service endpoint prefix which can be retrieved from the constant ENDPOINT_PREFIX of the specific service client interface, e.g. AmazonEC2.ENDPOINT_PREFIX.

hasHttpEndpoint

boolean hasHttpEndpoint(String serviceName)

Returns whether the given service support the http protocol in this region.

Parameters:

serviceName - The service endpoint prefix which can be retrieved from the constant ENDPOINT_PREFIX of the specific service client interface, e.g. AmazonEC2.ENDPOINT_PREFIX.

hasHttpsEndpoint

boolean hasHttpsEndpoint(String serviceName)

Returns whether the given service support the https protocol in this region.

Parameters:

serviceName - The service endpoint prefix which can be retrieved from the constant ENDPOINT_PREFIX of the specific service client interface, e.g. AmazonEC2.ENDPOINT_PREFIX.

getAvailableEndpoints

Collection<String> getAvailableEndpoints()

Returns an immutable collection of all the endpoints available in the region metadata.