com.github.alexdlaird.ngrok.protocol

Enum Region

java.lang.Object

java.lang.Enum<Region>

com.github.alexdlaird.ngrok.protocol.Region

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Region>

public enum Region
extends java.lang.Enum<Region>

An enum representing ngrok's valid regions, as defined in ngrok's docs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AP
AU
EU
IN
JP
SA
US
US_CAL_1

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static Region	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Region[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

US

@SerializedName(value="us")
public static final Region US

US_CAL_1

@SerializedName(value="us-cal-1")
public static final Region US_CAL_1

EU

@SerializedName(value="eu")
public static final Region EU

AP

@SerializedName(value="ap")
public static final Region AP

AU

@SerializedName(value="au")
public static final Region AU

SA

@SerializedName(value="sa")
public static final Region SA

JP

@SerializedName(value="jp")
public static final Region JP

IN

@SerializedName(value="in")
public static final Region IN

Method Detail

values

public static Region[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Region c : Region.values())
    System.out.println(c);

Returns:

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

valueOf

public static Region valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Region>