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

Class CDIVActivityV2

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

  • Field Details

  • Constructor Details

    • CDIVActivityV2

      public CDIVActivityV2()

  • Method Details

    • groupId

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

    • cusip

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

    • dueBillOffDate

      public CDIVActivityV2 dueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • getDueBillOffDate

      @Nullable public LocalDate getDueBillOffDate()
      When due bills stop applying for this event
      Returns:
      dueBillOffDate

    • setDueBillOffDate

      public void setDueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • dueBillOnDate

      public CDIVActivityV2 dueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • getDueBillOnDate

      @Nullable public LocalDate getDueBillOnDate()
      When due bills begin to apply for this event
      Returns:
      dueBillOnDate

    • setDueBillOnDate

      public void setDueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • exDate

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

    • foreign

      public CDIVActivityV2 foreign(@Nonnull Boolean foreign)

    • getForeign

      @Nonnull public Boolean getForeign()
      Indicates if related to a non-US security
      Returns:
      foreign

    • setForeign

      public void setForeign(@Nonnull Boolean foreign)

    • payableDate

      public CDIVActivityV2 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 CDIVActivityV2 rate(@Nonnull String rate)

    • getRate

      @Nonnull public String getRate()
      Dividend rate per share
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull String rate)

    • recordDate

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

    • special

      public CDIVActivityV2 special(@Nonnull Boolean special)

    • getSpecial

      @Nonnull public Boolean getSpecial()
      Indicates if this is a special dividend
      Returns:
      special

    • setSpecial

      public void setSpecial(@Nonnull Boolean special)

    • symbol

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

    • cashPayout

      public CDIVActivityV2 cashPayout(@Nonnull String cashPayout)

    • getCashPayout

      @Nonnull public String getCashPayout()
      Total cash amount paid
      Returns:
      cashPayout

    • setCashPayout

      public void setCashPayout(@Nonnull String cashPayout)

    • entitledQty

      public CDIVActivityV2 entitledQty(@Nonnull String entitledQty)

    • getEntitledQty

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

    • setEntitledQty

      public void setEntitledQty(@Nonnull String entitledQty)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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