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

Enum Class PortfolioRunStatus

java.lang.Object

java.lang.Enum<PortfolioRunStatus>

markets.alpaca.client.openapi.broker.model.PortfolioRunStatus

All Implemented Interfaces:

Serializable, Comparable<PortfolioRunStatus>, Constable

public enum PortfolioRunStatus
extends Enum<PortfolioRunStatus>
implements Serializable

| Status | Final | Represented State | Notes | |:------------------:|:-----:|:--------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------:| | QUEUED | No | The run has been queued, waiting for our system to process it. | Runs only executed when the US market is open and there's at least 15 minutes before the market closes. | | IN_PROGRESS | No | Portfolio adjustment is in progress. | | | CANCELED | Yes | Portfolio run canceled, before being picked up by Alpaca's background processing | | | CANCELED_MID_RUN | Yes | Portfolio run canceled while executing. | The portfolio's state is in between the pre-run and post-run state, manual remediation or job re-run is recommended. | | ERROR | Yes | There was an error while rebalancing the portfolio. | The portfolio's state is in between the pre-run and post-run state, manual remediation or job re-run is recommended. | | TIMEOUT | Yes | A timeout occurred while rebalancing the portfolio. | The portfolio's state is in between the pre-run and post-run state, manual remediation or job re-run is recommended. | | COMPLETED_ADJUSTED | Yes | The portfolio has been adjusted | The adjustments have been prepared, but the run details haven't yet updated with the list of resulting orders | | COMPLETED_SUCCESS | Yes | The portfolio has been adjusted, run status updated | |

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PortfolioRunStatus.Adapter

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELED
CANCELED_MID_RUN
COMPLETED_ADJUSTED
COMPLETED_SUCCESS
ERROR
IN_PROGRESS
QUEUED
TIMEOUT

Method Summary

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

QUEUED

public static final PortfolioRunStatus QUEUED

IN_PROGRESS

public static final PortfolioRunStatus IN_PROGRESS

CANCELED

public static final PortfolioRunStatus CANCELED

CANCELED_MID_RUN

public static final PortfolioRunStatus CANCELED_MID_RUN

ERROR

public static final PortfolioRunStatus ERROR

TIMEOUT

public static final PortfolioRunStatus TIMEOUT

COMPLETED_ADJUSTED

public static final PortfolioRunStatus COMPLETED_ADJUSTED

COMPLETED_SUCCESS

public static final PortfolioRunStatus COMPLETED_SUCCESS

Method Details

values

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

fromValue

public static PortfolioRunStatus fromValue(String value)

validateJsonElement

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

Throws:

IOException