Package markets.alpaca.client.openapi.broker.model

Enum Class SettlementStatus

java.lang.Object

java.lang.Enum<SettlementStatus>

markets.alpaca.client.openapi.broker.model.SettlementStatus

All Implemented Interfaces:

Serializable, Comparable<SettlementStatus>, Constable

public enum SettlementStatus
extends Enum<SettlementStatus>
implements Serializable

Values: * `PENDING`: Created and waiting to be processed * `AWAITING_ADDITIONAL_FUNDS`: Waiting for additional funds to be deposited * `COMPLETED`: All transactions are reconciled * `FAILED`: Attempt to process this settlement has failed. If this is observed additional remittance information may be required, or one of the transfers being settled accrued additional interest since the settlement was created.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SettlementStatus.Adapter

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AWAITING_ADDITIONAL_FUNDS
COMPLETED
FAILED
PENDING

Method Summary

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

PENDING

public static final SettlementStatus PENDING

AWAITING_ADDITIONAL_FUNDS

public static final SettlementStatus AWAITING_ADDITIONAL_FUNDS

COMPLETED

public static final SettlementStatus COMPLETED

FAILED

public static final SettlementStatus FAILED

Method Details

values

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

fromValue

public static SettlementStatus fromValue(String value)

validateJsonElement

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

Throws:

IOException