Package markets.alpaca.client.openapi.data.model

Enum Class Region

java.lang.Object

java.lang.Enum<Region>

markets.alpaca.client.openapi.data.model.Region

All Implemented Interfaces:

Serializable, Comparable<Region>, Constable

public enum Region
extends Enum<Region>
implements Serializable

The region to filter corporate actions by. - `us`: only US corporate actions - `non_us`: only non-US corporate actions - `all`: both US and non-US corporate actions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Region.Adapter

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
NON_US
US

Method Summary

Modifier and Type	Method	Description
static Region	fromValue(String value)
String	getValue()
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)
static Region	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Region[]	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

US

public static final Region US

NON_US

public static final Region NON_US

ALL

public static final Region ALL

Method Details

values

public static Region[] 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 Region 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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<Region>

fromValue

public static Region fromValue(String value)

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Throws:

IOException