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

Class CapitalGainsDistribution

java.lang.Object
markets.alpaca.client.openapi.data.model.CapitalGainsDistribution
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CapitalGainsDistribution extends Object implements Serializable
Capital gains distribution paid by a fund. A single event may carry a long-term leg (`long_term_rate`), a short-term leg (`short_term_rate`), or both when combined. At least one of the two rates is always present.
See Also:

  • Field Details

  • Constructor Details

    • CapitalGainsDistribution

      public CapitalGainsDistribution()

  • Method Details

    • currency

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

    • getCusip

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

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • exDate

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

    • id

      public CapitalGainsDistribution 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 CapitalGainsDistribution 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 CapitalGainsDistribution longTermRate(@Nullable Double longTermRate)

    • getLongTermRate

      @Nullable public Double getLongTermRate()
      Long-term capital-gain payment per share.
      Returns:
      longTermRate

    • setLongTermRate

      public void setLongTermRate(@Nullable Double longTermRate)

    • payableDate

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

    • recordDate

      public CapitalGainsDistribution 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 CapitalGainsDistribution shortTermRate(@Nullable Double shortTermRate)

    • getShortTermRate

      @Nullable public Double getShortTermRate()
      Short-term capital-gain payment per share.
      Returns:
      shortTermRate

    • setShortTermRate

      public void setShortTermRate(@Nullable Double shortTermRate)

    • symbol

      public CapitalGainsDistribution symbol(@Nonnull String symbol)

    • getSymbol

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

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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