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

Class AcatsCashBalance

java.lang.Object
markets.alpaca.client.openapi.broker.model.AcatsCashBalance
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class AcatsCashBalance extends Object implements Serializable
Cash balance
See Also:

  • Field Details

  • Constructor Details

    • AcatsCashBalance

      public AcatsCashBalance()

  • Method Details

    • amount

      public AcatsCashBalance amount(@Nullable BigDecimal amount)

    • getAmount

      @Nullable public BigDecimal getAmount()
      Amount of cash to be transferred. Can be positive or negative. Use `transfer_all` to transfer the entire balance instead of specifying an amount -- `amount` and `transfer_all: true` are mutually exclusive, and sending both is rejected with HTTP 400.
      Returns:
      amount

    • setAmount

      public void setAmount(@Nullable BigDecimal amount)

    • currency

      public AcatsCashBalance currency(@Nonnull AcatsCashBalance.CurrencyEnum currency)

    • getCurrency

      @Nonnull public AcatsCashBalance.CurrencyEnum getCurrency()
      Currency of the cash balance. Only `USD` is currently supported; any other value is rejected with HTTP 400. Each currency may appear at most once in the `cash` array.
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nonnull AcatsCashBalance.CurrencyEnum currency)

    • transferAll

      public AcatsCashBalance transferAll(@Nullable Boolean transferAll)

    • getTransferAll

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

    • setTransferAll

      public void setTransferAll(@Nullable Boolean transferAll)

    • putAdditionalProperty

      public AcatsCashBalance 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 AcatsCashBalance 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 AcatsCashBalance

    • fromJson

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

    • toJson

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