Package markets.alpaca.client.openapi.broker.model

Class CGDActivityV2

java.lang.Object
markets.alpaca.client.openapi.broker.model.CGDActivityV2
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CGDActivityV2 extends Object implements Serializable
Capital gains distribution. Used for both Long-Term (LTCG) and Short-Term (STCG) sub-types. Each activity represents a single leg; `long_term_rate` and/or `short_term_rate` are populated based on the source event, and `rate` matches the leg's own rate.
See Also:

  • Field Details

  • Constructor Details

    • CGDActivityV2

      public CGDActivityV2()

  • Method Details

    • groupId

      public CGDActivityV2 groupId(@Nullable UUID groupId)

    • getGroupId

      @Nullable public UUID getGroupId()
      Optional group ID which can help grouping together related activities
      Returns:
      groupId

    • setGroupId

      public void setGroupId(@Nullable UUID groupId)

    • systemDate

      public CGDActivityV2 systemDate(@Nonnull LocalDate systemDate)

    • getSystemDate

      @Nonnull public LocalDate getSystemDate()
      The date when the activity was booked
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nonnull LocalDate systemDate)

    • caId

      public CGDActivityV2 caId(@Nullable UUID caId)

    • getCaId

      @Nullable public UUID getCaId()
      The unique identifier for this corporate action
      Returns:
      caId

    • setCaId

      public void setCaId(@Nullable UUID caId)

    • positionDate

      public CGDActivityV2 positionDate(@Nonnull LocalDate positionDate)

    • getPositionDate

      @Nonnull public LocalDate getPositionDate()
      The position_date for this corporate action
      Returns:
      positionDate

    • setPositionDate

      public void setPositionDate(@Nonnull LocalDate positionDate)

    • reorgId

      public CGDActivityV2 reorgId(@Nullable String reorgId)

    • getReorgId

      @Nullable public String getReorgId()
      The reorg identifier, if present in the source corporate action definition
      Returns:
      reorgId

    • setReorgId

      public void setReorgId(@Nullable String reorgId)

    • cashPayout

      public CGDActivityV2 cashPayout(@Nonnull String cashPayout)

    • getCashPayout

      @Nonnull public String getCashPayout()
      Cash amount paid for this leg
      Returns:
      cashPayout

    • setCashPayout

      public void setCashPayout(@Nonnull String cashPayout)

    • cusip

      public CGDActivityV2 cusip(@Nonnull String cusip)

    • getCusip

      @Nonnull public String getCusip()
      The CUSIP of the security involved with the activity
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • entitledQty

      public CGDActivityV2 entitledQty(@Nonnull String entitledQty)

    • getEntitledQty

      @Nonnull public String getEntitledQty()
      Quantity of shares entitled to receive the capital gains distribution
      Returns:
      entitledQty

    • setEntitledQty

      public void setEntitledQty(@Nonnull String entitledQty)

    • exDate

      public CGDActivityV2 exDate(@Nullable LocalDate exDate)

    • getExDate

      @Nullable public LocalDate getExDate()
      The ex_date for this corporate action
      Returns:
      exDate

    • setExDate

      public void setExDate(@Nullable LocalDate exDate)

    • isin

      public CGDActivityV2 isin(@Nullable String isin)

    • getIsin

      @Nullable public String getIsin()
      The ISIN of the security involved with the activity
      Returns:
      isin

    • setIsin

      public void setIsin(@Nullable String isin)

    • longTermRate

      public CGDActivityV2 longTermRate(@Nullable String longTermRate)

    • getLongTermRate

      @Nullable public String getLongTermRate()
      Long-term capital gains distribution rate per share, when applicable
      Returns:
      longTermRate

    • setLongTermRate

      public void setLongTermRate(@Nullable String longTermRate)

    • payableDate

      public CGDActivityV2 payableDate(@Nullable LocalDate payableDate)

    • getPayableDate

      @Nullable public LocalDate getPayableDate()
      The payable_date for this corporate action
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nullable LocalDate payableDate)

    • rate

      public CGDActivityV2 rate(@Nonnull String rate)

    • getRate

      @Nonnull public String getRate()
      Distribution rate per share for this leg (LTCG or STCG)
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull String rate)

    • recordDate

      public CGDActivityV2 recordDate(@Nullable LocalDate recordDate)

    • getRecordDate

      @Nullable public LocalDate getRecordDate()
      The record_date for this corporate action
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable LocalDate recordDate)

    • shortTermRate

      public CGDActivityV2 shortTermRate(@Nullable String shortTermRate)

    • getShortTermRate

      @Nullable public String getShortTermRate()
      Short-term capital gains distribution rate per share, when applicable
      Returns:
      shortTermRate

    • setShortTermRate

      public void setShortTermRate(@Nullable String shortTermRate)

    • symbol

      public CGDActivityV2 symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      The symbol of the security involved with the activity
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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