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

Class REOActivityV2

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

  • Field Details

  • Constructor Details

    • REOActivityV2

      public REOActivityV2()

  • Method Details

    • groupId

      public REOActivityV2 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 REOActivityV2 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 REOActivityV2 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 REOActivityV2 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 REOActivityV2 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 REOActivityV2 cashPayout(@Nullable BigDecimal cashPayout)

    • getCashPayout

      @Nullable public BigDecimal getCashPayout()
      Cash payout amount
      Returns:
      cashPayout

    • setCashPayout

      public void setCashPayout(@Nullable BigDecimal cashPayout)

    • cashRate

      public REOActivityV2 cashRate(@Nullable BigDecimal cashRate)

    • getCashRate

      @Nullable public BigDecimal getCashRate()
      Cash rate per share
      Returns:
      cashRate

    • setCashRate

      public void setCashRate(@Nullable BigDecimal cashRate)

    • cusip

      public REOActivityV2 cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      CUSIP received on this stock leg
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • effectiveDate

      public REOActivityV2 effectiveDate(@Nullable LocalDate effectiveDate)

    • getEffectiveDate

      @Nullable public LocalDate getEffectiveDate()
      Effective date of the reorganization
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nullable LocalDate effectiveDate)

    • isin

      public REOActivityV2 isin(@Nullable String isin)

    • getIsin

      @Nullable public String getIsin()
      ISIN received on this stock leg
      Returns:
      isin

    • setIsin

      public void setIsin(@Nullable String isin)

    • newRate

      public REOActivityV2 newRate(@Nullable BigDecimal newRate)

    • getNewRate

      @Nullable public BigDecimal getNewRate()
      New ratio for this stock leg
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nullable BigDecimal newRate)

    • payableDate

      public REOActivityV2 payableDate(@Nonnull LocalDate payableDate)

    • getPayableDate

      @Nonnull public LocalDate getPayableDate()
      Payable date of the reorganization
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nonnull LocalDate payableDate)

    • qty

      public REOActivityV2 qty(@Nullable BigDecimal qty)

    • getQty

      @Nullable public BigDecimal getQty()
      Quantity received on this stock leg
      Returns:
      qty

    • setQty

      public void setQty(@Nullable BigDecimal qty)

    • removedQty

      public REOActivityV2 removedQty(@Nullable BigDecimal removedQty)

    • getRemovedQty

      @Nullable public BigDecimal getRemovedQty()
      Positive quantity removed from the source position
      Returns:
      removedQty

    • setRemovedQty

      public void setRemovedQty(@Nullable BigDecimal removedQty)

    • sourceCusip

      public REOActivityV2 sourceCusip(@Nonnull String sourceCusip)

    • getSourceCusip

      @Nonnull public String getSourceCusip()
      CUSIP of the source security
      Returns:
      sourceCusip

    • setSourceCusip

      public void setSourceCusip(@Nonnull String sourceCusip)

    • sourceIsin

      public REOActivityV2 sourceIsin(@Nullable String sourceIsin)

    • getSourceIsin

      @Nullable public String getSourceIsin()
      ISIN of the source security
      Returns:
      sourceIsin

    • setSourceIsin

      public void setSourceIsin(@Nullable String sourceIsin)

    • sourceQty

      public REOActivityV2 sourceQty(@Nullable BigDecimal sourceQty)

    • getSourceQty

      @Nullable public BigDecimal getSourceQty()
      Source position quantity
      Returns:
      sourceQty

    • setSourceQty

      public void setSourceQty(@Nullable BigDecimal sourceQty)

    • sourceRate

      public REOActivityV2 sourceRate(@Nullable BigDecimal sourceRate)

    • getSourceRate

      @Nullable public BigDecimal getSourceRate()
      Source ratio for this stock leg
      Returns:
      sourceRate

    • setSourceRate

      public void setSourceRate(@Nullable BigDecimal sourceRate)

    • sourceSymbol

      public REOActivityV2 sourceSymbol(@Nonnull String sourceSymbol)

    • getSourceSymbol

      @Nonnull public String getSourceSymbol()
      Symbol of the source security
      Returns:
      sourceSymbol

    • setSourceSymbol

      public void setSourceSymbol(@Nonnull String sourceSymbol)

    • symbol

      public REOActivityV2 symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      Symbol received on this stock leg
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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