com.ibm.cloud.objectstorage.regions

Class RegionMetadata

java.lang.Object

com.ibm.cloud.objectstorage.regions.RegionMetadata

public class RegionMetadata
extends Object

A collection of metadata about a set of regions and the services they contain.

See Also:

RegionUtils

Constructor Summary

Constructors

Constructor and Description
RegionMetadata(List<Region> regions) Creates a new RegionMetadata object from the given list of regions.
RegionMetadata(RegionMetadataProvider provider)

Method Summary

Modifier and Type	Method and Description
Region	getRegion(String name) Returns the region with the name given, if it exists.
Region	getRegionByEndpoint(String endpoint) Deprecated. sdk no longer holds the complete endpoint for every service in the region. It now uses the partition metadata to compute the endpoints dynamically for new regions and services.
List<Region>	getRegions() Returns an immutable list of all regions known to this region metadata object, in no particular order.
List<Region>	getRegionsForService(String service) Returns a list of the regions that support the service given.
String	toString()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RegionMetadata

public RegionMetadata(List<Region> regions)

Creates a new RegionMetadata object from the given list of regions.

Parameters:

regions - the list of regions

RegionMetadata

public RegionMetadata(RegionMetadataProvider provider)

Method Detail

getRegions

public 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

public Region getRegion(String name)

Returns the region with the name given, if it exists. Otherwise, returns null.

Parameters:

name - the name of the region to search for

Returns:

the corresponding region, if it exists

getRegionsForService

public List<Region> getRegionsForService(String service)

Returns a list of the regions that support the service given.

Parameters:

service - 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

tryGetRegionByExplicitEndpoint

public 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 RegionMetadata.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

public 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 RegionMetadata.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.

getRegionByEndpoint

@Deprecated
public Region getRegionByEndpoint(String endpoint)

Deprecated. sdk no longer holds the complete endpoint for every service in the region. It now uses the partition metadata to compute the endpoints dynamically for new regions and services.

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.

Throws:

IllegalArgumentException - If the given URL is malformed, or if the one of the service URLs on record is malformed.

toString

public String toString()

Overrides:

toString in class Object