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

Class CaEventUnitSplit

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventUnitSplit
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventUnitSplit extends Object implements Serializable
Unit split payload delivered when `event_type == unit_split_corporateaction_event`. Corresponds to `unit_splits` on the REST [`GET /v1/corporate-actions`](#operation/CorporateActions) response, but every decimal field is emitted as a JSON string to preserve precision on the wire.
See Also:

  • Field Details

  • Constructor Details

    • CaEventUnitSplit

      public CaEventUnitSplit()

  • Method Details

    • id

      public CaEventUnitSplit 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)

    • processDate

      public CaEventUnitSplit 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)

    • alternateCusip

      public CaEventUnitSplit alternateCusip(@Nonnull String alternateCusip)

    • getAlternateCusip

      @Nonnull public String getAlternateCusip()
      CUSIP of the secondary leg.
      Returns:
      alternateCusip

    • setAlternateCusip

      public void setAlternateCusip(@Nonnull String alternateCusip)

    • alternateIsin

      public CaEventUnitSplit 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 CaEventUnitSplit alternateRate(@Nonnull String alternateRate)

    • getAlternateRate

      @Nonnull public String getAlternateRate()
      Secondary-leg shares delivered per unit, as a decimal string.
      Returns:
      alternateRate

    • setAlternateRate

      public void setAlternateRate(@Nonnull String alternateRate)

    • alternateSymbol

      public CaEventUnitSplit alternateSymbol(@Nonnull String alternateSymbol)

    • getAlternateSymbol

      @Nonnull public String getAlternateSymbol()
      Ticker of the secondary leg (usually a warrant).
      Returns:
      alternateSymbol

    • setAlternateSymbol

      public void setAlternateSymbol(@Nonnull String alternateSymbol)

    • currency

      public CaEventUnitSplit 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 CaEventUnitSplit 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)

    • newCusip

      public CaEventUnitSplit newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      CUSIP of the primary leg.
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newIsin

      public CaEventUnitSplit 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 CaEventUnitSplit newRate(@Nonnull String newRate)

    • getNewRate

      @Nonnull public String getNewRate()
      Primary-leg shares delivered per unit, as a decimal string.
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nonnull String newRate)

    • newSymbol

      public CaEventUnitSplit newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Ticker of the primary leg (usually the common share).
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • oldCusip

      public CaEventUnitSplit oldCusip(@Nonnull String oldCusip)

    • getOldCusip

      @Nonnull public String getOldCusip()
      CUSIP of the unit.
      Returns:
      oldCusip

    • setOldCusip

      public void setOldCusip(@Nonnull String oldCusip)

    • oldIsin

      public CaEventUnitSplit 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 CaEventUnitSplit oldRate(@Nonnull String oldRate)

    • getOldRate

      @Nonnull public String getOldRate()
      Units per ratio unit, as a decimal string.
      Returns:
      oldRate

    • setOldRate

      public void setOldRate(@Nonnull String oldRate)

    • oldSymbol

      public CaEventUnitSplit oldSymbol(@Nonnull String oldSymbol)

    • getOldSymbol

      @Nonnull public String getOldSymbol()
      Ticker of the unit being split.
      Returns:
      oldSymbol

    • setOldSymbol

      public void setOldSymbol(@Nonnull String oldSymbol)

    • payableDate

      public CaEventUnitSplit 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)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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