Package com.vonage.client

Enum Class ApiRegion

java.lang.Object

java.lang.Enum<ApiRegion>

com.vonage.client.ApiRegion

All Implemented Interfaces:

Serializable, Comparable<ApiRegion>, java.lang.constant.Constable

public enum ApiRegion
extends Enum<ApiRegion>

Enum representing the different regions that the Vonage API can be accessed from.

Since:

8.11.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
API_AP	The region for the Vonage API in Asia Pacific.
API_EU	The region for the Vonage API in Europe.
API_US	The region for the Vonage API in the US.

Method Summary

Modifier and Type	Method	Description
static ApiRegion	fromString(String region)	Converts a string representation of a region to the corresponding enum value.
String	toString()
static ApiRegion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiRegion[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

API_EU

public static final ApiRegion API_EU

The region for the Vonage API in Europe.

API_US

public static final ApiRegion API_US

The region for the Vonage API in the US.

API_AP

public static final ApiRegion API_AP

The region for the Vonage API in Asia Pacific.

Method Details

values

public static ApiRegion[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ApiRegion valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ApiRegion>

fromString

public static ApiRegion fromString(String region)

Converts a string representation of a region to the corresponding enum value.

Parameters:

region - The region as a string.

Returns:

The region enum, or null if the input is null.