com.ibm.cloud.objectstorage.regions

Class Region

java.lang.Object

com.ibm.cloud.objectstorage.regions.Region

public class Region
extends Object

Metadata for an AWS region, including its name and what services are available in it.

Constructor Summary

Constructors

Constructor and Description
Region(RegionImpl regionImpl)

Method Summary

Modifier and Type	Method and Description
<T extends AmazonWebServiceClient> T	createClient(Class<T> serviceClass, AWSCredentialsProvider credentials, ClientConfiguration config) Deprecated. use appropriate AwsClientBuilder implementation for the service being constructed. For example: AmazonSNSClientBuilder.standard().withRegion(region).build();
boolean	equals(Object obj)
Collection<String>	getAvailableEndpoints() Returns a immutable collection of all endpoints available in the 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.
static Region	getRegion(Regions region) Returns the region with the id given, or null if it cannot be found in the current regions.xml file.
String	getServiceEndpoint(String endpointPrefix) Returns the endpoint for the service given.
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Region

public Region(RegionImpl regionImpl)

Method Detail

getRegion

public static Region getRegion(Regions region)

Returns the region with the id given, or null if it cannot be found in the current regions.xml file.

getName

public String getName()

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

Returns:

The unique system ID for this region.

getDomain

public String getDomain()

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

Returns:

The domain for this region.

getPartition

public String getPartition()

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

Returns:

The partition this region is in.

getServiceEndpoint

public String getServiceEndpoint(String endpointPrefix)

Returns the endpoint for the service given.

Parameters:

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

isServiceSupported

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

hasHttpsEndpoint

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

hasHttpEndpoint

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

getAvailableEndpoints

public Collection<String> getAvailableEndpoints()

Returns a immutable collection of all endpoints available in the metadata.

createClient

@Deprecated
public <T extends AmazonWebServiceClient> T createClient(Class<T> serviceClass,
                                                                     AWSCredentialsProvider credentials,
                                                                     ClientConfiguration config)

Deprecated. use appropriate AwsClientBuilder implementation for the service being constructed. For example: AmazonSNSClientBuilder.standard().withRegion(region).build();

Creates a new service client of the class given and configures it. If credentials or config are null, defaults will be used.

Parameters:

serviceClass - The service client class to instantiate, e.g. AmazonS3Client.class

credentials - The credentials provider to use, or null for the default credentials provider

config - The configuration to use, or null for the default configuration

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object