com.amazonaws.regions

Class RegionMetadata

java.lang.Object

com.amazonaws.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()

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

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