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

Class RightsDistributionActivityV2

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

  • Field Details

  • Constructor Details

    • RightsDistributionActivityV2

      public RightsDistributionActivityV2()

  • Method Details

    • groupId

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

    • exDate

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

    • expirationDate

      public RightsDistributionActivityV2 expirationDate(@Nullable LocalDate expirationDate)

    • getExpirationDate

      @Nullable public LocalDate getExpirationDate()
      The expiration date for the rights distribution
      Returns:
      expirationDate

    • setExpirationDate

      public void setExpirationDate(@Nullable LocalDate expirationDate)

    • newCusip

      public RightsDistributionActivityV2 newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      The new CUSIP
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newQty

      public RightsDistributionActivityV2 newQty(@Nonnull String newQty)

    • getNewQty

      @Nonnull public String getNewQty()
      The new quantity
      Returns:
      newQty

    • setNewQty

      public void setNewQty(@Nonnull String newQty)

    • newSymbol

      public RightsDistributionActivityV2 newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      The new symbol
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • payableDate

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

    • getRate

      @Nonnull public String getRate()
      The rate for the rights distribution
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull String rate)

    • recordDate

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

    • sourceCusip

      public RightsDistributionActivityV2 sourceCusip(@Nonnull String sourceCusip)

    • getSourceCusip

      @Nonnull public String getSourceCusip()
      The source CUSIP
      Returns:
      sourceCusip

    • setSourceCusip

      public void setSourceCusip(@Nonnull String sourceCusip)

    • sourceQty

      public RightsDistributionActivityV2 sourceQty(@Nonnull String sourceQty)

    • getSourceQty

      @Nonnull public String getSourceQty()
      The source quantity
      Returns:
      sourceQty

    • setSourceQty

      public void setSourceQty(@Nonnull String sourceQty)

    • sourceSymbol

      public RightsDistributionActivityV2 sourceSymbol(@Nonnull String sourceSymbol)

    • getSourceSymbol

      @Nonnull public String getSourceSymbol()
      The source symbol
      Returns:
      sourceSymbol

    • setSourceSymbol

      public void setSourceSymbol(@Nonnull String sourceSymbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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