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

Class CashDividend

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

  • Field Details

  • Constructor Details

    • CashDividend

      public CashDividend()

  • Method Details

    • currency

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

    • getCusip

      @Nonnull public String getCusip()
      Get cusip
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • dueBillOffDate

      public CashDividend dueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • getDueBillOffDate

      @Nullable public LocalDate getDueBillOffDate()
      Get dueBillOffDate
      Returns:
      dueBillOffDate

    • setDueBillOffDate

      public void setDueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • dueBillOnDate

      public CashDividend dueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • getDueBillOnDate

      @Nullable public LocalDate getDueBillOnDate()
      Get dueBillOnDate
      Returns:
      dueBillOnDate

    • setDueBillOnDate

      public void setDueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • exDate

      public CashDividend 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 CashDividend foreign(@Nonnull Boolean foreign)

    • getForeign

      @Nonnull public Boolean getForeign()
      Get foreign
      Returns:
      foreign

    • setForeign

      public void setForeign(@Nonnull Boolean foreign)

    • id

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

    • isin

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

    • rate

      public CashDividend rate(@Nonnull Double rate)

    • getRate

      @Nonnull public Double getRate()
      Get rate
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull Double rate)

    • recordDate

      public CashDividend 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 CashDividend special(@Nonnull Boolean special)

    • getSpecial

      @Nonnull public Boolean getSpecial()
      Get special
      Returns:
      special

    • setSpecial

      public void setSpecial(@Nonnull Boolean special)

    • subType

      public CashDividend subType(@Nullable CashDividend.SubTypeEnum subType)

    • getSubType

      @Nullable public CashDividend.SubTypeEnum getSubType()
      Sub-type of the cash dividend.
      Returns:
      subType

    • setSubType

      public void setSubType(@Nullable CashDividend.SubTypeEnum subType)

    • symbol

      public CashDividend symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Get symbol
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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