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

Class AcatsEquity

java.lang.Object
markets.alpaca.client.openapi.broker.model.AcatsEquity
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class AcatsEquity extends Object implements Serializable
Equity asset requested in a partial transfer. Identify the security with either `cusip` or `symbol` -- provide one, not both. Prefer `cusip` when you have it: it is a stable, unambiguous identifier. Use `symbol` only when a CUSIP is not available, as ticker symbols can change or be reused over time.
See Also:

  • Field Details

  • Constructor Details

    • AcatsEquity

      public AcatsEquity()

  • Method Details

    • cusip

      public AcatsEquity cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      CUSIP security identifier for the asset -- 8 uppercase alphanumeric characters followed by a check character, which may be a digit or one of `*`, `@`, `#`. Recommended over `symbol` for unambiguous identification. Provide either `cusip` or `symbol`, not both.
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • position

      public AcatsEquity position(@Nullable AcatsEquity.PositionEnum position)

    • getPosition

      @Nullable public AcatsEquity.PositionEnum getPosition()
      Position type. Only `LONG` and `SHORT` are accepted for equities -- `CREDIT` and `DEBIT` apply to cash positions and are rejected with HTTP 400 here.
      Returns:
      position

    • setPosition

      public void setPosition(@Nullable AcatsEquity.PositionEnum position)

    • qty

      public AcatsEquity qty(@Nullable BigDecimal qty)

    • getQty

      @Nullable public BigDecimal getQty()
      Quantity of assets to transfer. Use `transfer_all` to transfer the entire position instead of specifying a quantity -- `qty` and `transfer_all: true` are mutually exclusive, and sending both is rejected with HTTP 400. Note that the ACATS system will only transfer whole shares.
      Returns:
      qty

    • setQty

      public void setQty(@Nullable BigDecimal qty)

    • symbol

      public AcatsEquity symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      Stock ticker symbol (e.g. `AAPL`, `BRK.B`, `GOOGL`). Up to 6 alphanumeric characters, optionally followed by a single `.` or `-` separator and a 1-5 letter suffix. Values are trimmed and upper-cased before validation. Use only when a CUSIP is not available, since symbols can change or be reused over time. Provide either `cusip` or `symbol`, not both.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • transferAll

      public AcatsEquity transferAll(@Nullable Boolean transferAll)

    • getTransferAll

      @Nullable public Boolean getTransferAll()
      Set to true to transfer the entire balance of this asset. Must not be combined with `qty`. Setting it to `false` without a `qty` is rejected with HTTP 400.
      Returns:
      transferAll

    • setTransferAll

      public void setTransferAll(@Nullable Boolean transferAll)

    • putAdditionalProperty

      public AcatsEquity putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the AcatsEquity instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to AcatsEquity

    • fromJson

      public static AcatsEquity fromJson(String jsonString) throws IOException
      Create an instance of AcatsEquity given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of AcatsEquity
      Throws:
      IOException - if the JSON string is invalid with respect to AcatsEquity

    • toJson

      public String toJson()
      Convert an instance of AcatsEquity to an JSON string
      Returns:
      JSON string