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

Class CaEventCapitalGainsDistribution

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventCapitalGainsDistribution
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventCapitalGainsDistribution extends Object implements Serializable
Capital-gains distribution payload delivered when `event_type == capital_gains_distribution_corporateaction_event`. Every decimal field is emitted as a JSON string to preserve precision on the wire. At least one of `long_term_rate` / `short_term_rate` is present; combined distributions carry both.
See Also:

  • Field Details

  • Constructor Details

    • CaEventCapitalGainsDistribution

      public CaEventCapitalGainsDistribution()

  • Method Details

    • id

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

    • getCusip

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

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • exDate

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

    • longTermRate

      public CaEventCapitalGainsDistribution longTermRate(@Nullable String longTermRate)

    • getLongTermRate

      @Nullable public String getLongTermRate()
      Long-term capital-gains payment per share, as a decimal string.
      Returns:
      longTermRate

    • setLongTermRate

      public void setLongTermRate(@Nullable String longTermRate)

    • payableDate

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

    • shortTermRate

      public CaEventCapitalGainsDistribution shortTermRate(@Nullable String shortTermRate)

    • getShortTermRate

      @Nullable public String getShortTermRate()
      Short-term capital-gains payment per share, as a decimal string.
      Returns:
      shortTermRate

    • setShortTermRate

      public void setShortTermRate(@Nullable String shortTermRate)

    • symbol

      public CaEventCapitalGainsDistribution symbol(@Nonnull String symbol)

    • getSymbol

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

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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