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

Class CaEventForwardSplit

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventForwardSplit
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventForwardSplit extends Object implements Serializable
Forward stock split payload delivered when `event_type == forward_split_corporateaction_event`. Corresponds to `forward_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

    • CaEventForwardSplit

      public CaEventForwardSplit()

  • Method Details

    • id

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

    • currency

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

    • cusip

      public CaEventForwardSplit cusip(@Nonnull String cusip)

    • getCusip

      @Nonnull public String getCusip()
      CUSIP of the security.
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • dueBillRedemptionDate

      public CaEventForwardSplit dueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • getDueBillRedemptionDate

      @Nullable public LocalDate getDueBillRedemptionDate()
      The date when due bill obligations are redeemed.
      Returns:
      dueBillRedemptionDate

    • setDueBillRedemptionDate

      public void setDueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • exDate

      public CaEventForwardSplit exDate(@Nonnull LocalDate exDate)

    • getExDate

      @Nonnull public LocalDate getExDate()
      The ex-date marks the cutoff point for shareholders to be credited.
      Returns:
      exDate

    • setExDate

      public void setExDate(@Nonnull LocalDate exDate)

    • isin

      public CaEventForwardSplit isin(@Nullable String isin)

    • getIsin

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

    • setIsin

      public void setIsin(@Nullable String isin)

    • newRate

      public CaEventForwardSplit newRate(@Nonnull String newRate)

    • getNewRate

      @Nonnull public String getNewRate()
      Shares after the split, as a decimal string.
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nonnull String newRate)

    • oldRate

      public CaEventForwardSplit oldRate(@Nonnull String oldRate)

    • getOldRate

      @Nonnull public String getOldRate()
      Shares before the split, as a decimal string.
      Returns:
      oldRate

    • setOldRate

      public void setOldRate(@Nonnull String oldRate)

    • payableDate

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

    • recordDate

      public CaEventForwardSplit recordDate(@Nullable LocalDate recordDate)

    • getRecordDate

      @Nullable public LocalDate getRecordDate()
      The date shareholders must own shares to receive the benefit.
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable LocalDate recordDate)

    • symbol

      public CaEventForwardSplit symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Ticker being split.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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