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

Class CaEventCashDividend

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

    • CaEventCashDividend

      public CaEventCashDividend()

  • Method Details

    • id

      public CaEventCashDividend 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 CaEventCashDividend 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 CaEventCashDividend 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 CaEventCashDividend cusip(@Nonnull String cusip)

    • getCusip

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

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • dueBillOffDate

      public CaEventCashDividend dueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • getDueBillOffDate

      @Nullable public LocalDate getDueBillOffDate()
      End of the due-bill period.
      Returns:
      dueBillOffDate

    • setDueBillOffDate

      public void setDueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • dueBillOnDate

      public CaEventCashDividend dueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • getDueBillOnDate

      @Nullable public LocalDate getDueBillOnDate()
      Start of the due-bill period.
      Returns:
      dueBillOnDate

    • setDueBillOnDate

      public void setDueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • exDate

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

    • foreign

      public CaEventCashDividend foreign(@Nonnull Boolean foreign)

    • getForeign

      @Nonnull public Boolean getForeign()
      `true` if the issuer is not US-based.
      Returns:
      foreign

    • setForeign

      public void setForeign(@Nonnull Boolean foreign)

    • isin

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

    • payableDate

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

    • rate

      public CaEventCashDividend rate(@Nonnull String rate)

    • getRate

      @Nonnull public String getRate()
      Cash paid per share, as a decimal string.
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull String rate)

    • recordDate

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

    • special

      public CaEventCashDividend special(@Nonnull Boolean special)

    • getSpecial

      @Nonnull public Boolean getSpecial()
      `true` if this is a one-off dividend outside the issuer's regular distribution schedule.
      Returns:
      special

    • setSpecial

      public void setSpecial(@Nonnull Boolean special)

    • subType

      public CaEventCashDividend subType(@Nullable CaEventCashDividend.SubTypeEnum subType)

    • getSubType

      @Nullable public CaEventCashDividend.SubTypeEnum getSubType()
      Optional sub-classification of the dividend.
      Returns:
      subType

    • setSubType

      public void setSubType(@Nullable CaEventCashDividend.SubTypeEnum subType)

    • symbol

      public CaEventCashDividend symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Ticker paying the dividend.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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