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

Class UnitSplit

java.lang.Object
markets.alpaca.client.openapi.data.model.UnitSplit
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class UnitSplit extends Object implements Serializable
Unit split.
See Also:

  • Field Details

  • Constructor Details

    • UnitSplit

      public UnitSplit()

  • Method Details

    • alternateCusip

      public UnitSplit alternateCusip(@Nonnull String alternateCusip)

    • getAlternateCusip

      @Nonnull public String getAlternateCusip()
      Get alternateCusip
      Returns:
      alternateCusip

    • setAlternateCusip

      public void setAlternateCusip(@Nonnull String alternateCusip)

    • alternateIsin

      public UnitSplit alternateIsin(@Nullable String alternateIsin)

    • getAlternateIsin

      @Nullable public String getAlternateIsin()
      International Securities Identification Number (ISIN) as defined by ISO 6166. May be empty for US corporate actions.
      Returns:
      alternateIsin

    • setAlternateIsin

      public void setAlternateIsin(@Nullable String alternateIsin)

    • alternateRate

      public UnitSplit alternateRate(@Nonnull Double alternateRate)

    • getAlternateRate

      @Nonnull public Double getAlternateRate()
      Get alternateRate
      Returns:
      alternateRate

    • setAlternateRate

      public void setAlternateRate(@Nonnull Double alternateRate)

    • alternateSymbol

      public UnitSplit alternateSymbol(@Nonnull String alternateSymbol)

    • getAlternateSymbol

      @Nonnull public String getAlternateSymbol()
      Get alternateSymbol
      Returns:
      alternateSymbol

    • setAlternateSymbol

      public void setAlternateSymbol(@Nonnull String alternateSymbol)

    • currency

      public UnitSplit currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      The ISO 4217 currency code associated with the corporate action. Empty value can mean USD, non-applicable (e.g. for name changes) or unknown (can change later to a valid currency).
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • effectiveDate

      public UnitSplit effectiveDate(@Nonnull LocalDate effectiveDate)

    • getEffectiveDate

      @Nonnull public LocalDate getEffectiveDate()
      The effective date marks the cutoff point for shareholders to be credited.
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nonnull LocalDate effectiveDate)

    • id

      public UnitSplit id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      The internal Alpaca identifier of the corporate action.
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • newCusip

      public UnitSplit newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      Get newCusip
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newIsin

      public UnitSplit newIsin(@Nullable String newIsin)

    • getNewIsin

      @Nullable public String getNewIsin()
      International Securities Identification Number (ISIN) as defined by ISO 6166. May be empty for US corporate actions.
      Returns:
      newIsin

    • setNewIsin

      public void setNewIsin(@Nullable String newIsin)

    • newRate

      public UnitSplit newRate(@Nonnull Double newRate)

    • getNewRate

      @Nonnull public Double getNewRate()
      Get newRate
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nonnull Double newRate)

    • newSymbol

      public UnitSplit newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Get newSymbol
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • oldCusip

      public UnitSplit oldCusip(@Nonnull String oldCusip)

    • getOldCusip

      @Nonnull public String getOldCusip()
      Get oldCusip
      Returns:
      oldCusip

    • setOldCusip

      public void setOldCusip(@Nonnull String oldCusip)

    • oldIsin

      public UnitSplit oldIsin(@Nullable String oldIsin)

    • getOldIsin

      @Nullable public String getOldIsin()
      International Securities Identification Number (ISIN) as defined by ISO 6166. May be empty for US corporate actions.
      Returns:
      oldIsin

    • setOldIsin

      public void setOldIsin(@Nullable String oldIsin)

    • oldRate

      public UnitSplit oldRate(@Nonnull Double oldRate)

    • getOldRate

      @Nonnull public Double getOldRate()
      Get oldRate
      Returns:
      oldRate

    • setOldRate

      public void setOldRate(@Nonnull Double oldRate)

    • oldSymbol

      public UnitSplit oldSymbol(@Nonnull String oldSymbol)

    • getOldSymbol

      @Nonnull public String getOldSymbol()
      Get oldSymbol
      Returns:
      oldSymbol

    • setOldSymbol

      public void setOldSymbol(@Nonnull String oldSymbol)

    • payableDate

      public UnitSplit payableDate(@Nullable LocalDate payableDate)

    • getPayableDate

      @Nullable public LocalDate getPayableDate()
      The date when the corporate action benefit is paid or distributed.
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nullable LocalDate payableDate)

    • processDate

      public UnitSplit processDate(@Nonnull LocalDate processDate)

    • getProcessDate

      @Nonnull public LocalDate getProcessDate()
      The date when the corporate action is processed by Alpaca.
      Returns:
      processDate

    • setProcessDate

      public void setProcessDate(@Nonnull LocalDate processDate)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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