com.ibm.cloud.objectstorage.regions

Interface RegionMetadataProvider

All Known Implementing Classes:

AbstractRegionMetadataProvider, InMemoryRegionsProvider, PartitionMetadataProvider

public interface RegionMetadataProvider

Method Summary

Modifier and Type	Method and Description
Region	getRegion(String regionName) Returns the region with the name given, if it exists in the metadata or if it can be derived from the metadata.
Region	getRegionByEndpoint(String endpoint) Searches through all known regions to find one with any service at the specified endpoint.
List<Region>	getRegions() Returns an immutable list of all regions known to this region metadata object, in no particular order.
List<Region>	getRegionsForService(String serviceName) Returns a list of the regions that support the service given.
Region	tryGetRegionByEndpointDnsSuffix(String endpoint) Returns the region associated with the specified endpoint by searching the endpoint configuration for a partition that matches the DNS suffix of the provided endpoint and extracting the region name based on the endpoint pattern for that partition.
Region	tryGetRegionByExplicitEndpoint(String endpoint) Returns the region associated with the specified endpoint by searching the endpoint configuration for an endpoint that is explicitly listed.

Method Detail

getRegions

List<Region> getRegions()

Returns an immutable list of all regions known to this region metadata object, in no particular order.

Returns:

an immutable list of all regions

getRegion

Region getRegion(String regionName)

Returns the region with the name given, if it exists in the metadata or if it can be derived from the metadata. Otherwise, returns null.

Parameters:

regionName - the name of the region to search for

Returns:

the corresponding region, if it exists or derived.

getRegionsForService

List<Region> getRegionsForService(String serviceName)

Returns a list of the regions that support 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.

Returns:

the list of regions with support for the given service

getRegionByEndpoint

Region getRegionByEndpoint(String endpoint)

Searches through all known regions to find one with any service at the specified endpoint. If no region is found with a service at that endpoint, an exception is thrown.

Parameters:

endpoint - The endpoint for any service residing in the desired region.

Returns:

The region containing any service running at the specified endpoint, otherwise an exception is thrown if no region is found with a service at the specified endpoint.

tryGetRegionByExplicitEndpoint

Region tryGetRegionByExplicitEndpoint(String endpoint)

Returns the region associated with the specified endpoint by searching the endpoint configuration for an endpoint that is explicitly listed. This is likely to be null, because most endpoints are not explicitly listed in the endpoints file. This is mostly useful for retrieving the region of non-standard endpoints that do not include the region in the host name. These include global endpoints (budgets.amazonaws.com), Unlike RegionMetadataProvider.getRegionByEndpoint(String), this returns null on failure instead of raising an exception.

Parameters:

endpoint - The endpoint to look up in the region metadata.

Returns:

The region, or null if it cannot be determined.

tryGetRegionByEndpointDnsSuffix

Region tryGetRegionByEndpointDnsSuffix(String endpoint)

Returns the region associated with the specified endpoint by searching the endpoint configuration for a partition that matches the DNS suffix of the provided endpoint and extracting the region name based on the endpoint pattern for that partition. This may be wrong if the service does not follow the endpoint pattern for the partition. This returns null if the endpoint provided does not appear to include a region, or does not match a known partition DNS suffix. Unlike RegionMetadataProvider.getRegionByEndpoint(String), this returns null on failure instead of raising an exception.

Parameters:

endpoint - The endpoint to look up in the region metadata based on the DNS suffix.

Returns:

The region, or null if it cannot be determined.