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

Class OpcaUSPLITActivityV2

java.lang.Object
markets.alpaca.client.openapi.broker.model.OpcaUSPLITActivityV2
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class OpcaUSPLITActivityV2 extends Object implements Serializable
Options corporate action of unit-splits
See Also:

  • Field Details

  • Constructor Details

    • OpcaUSPLITActivityV2

      public OpcaUSPLITActivityV2()

  • Method Details

    • groupId

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

    • newContractSymbol

      public OpcaUSPLITActivityV2 newContractSymbol(@Nonnull String newContractSymbol)

    • getNewContractSymbol

      @Nonnull public String getNewContractSymbol()
      The new contract symbol
      Returns:
      newContractSymbol

    • setNewContractSymbol

      public void setNewContractSymbol(@Nonnull String newContractSymbol)

    • newQty

      public OpcaUSPLITActivityV2 newQty(@Nullable String newQty)

    • getNewQty

      @Nullable public String getNewQty()
      used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'.
      Returns:
      newQty

    • setNewQty

      public void setNewQty(@Nullable String newQty)

    • oldContractSymbol

      public OpcaUSPLITActivityV2 oldContractSymbol(@Nonnull String oldContractSymbol)

    • getOldContractSymbol

      @Nonnull public String getOldContractSymbol()
      The old contract symbol
      Returns:
      oldContractSymbol

    • setOldContractSymbol

      public void setOldContractSymbol(@Nonnull String oldContractSymbol)

    • oldQty

      public OpcaUSPLITActivityV2 oldQty(@Nullable String oldQty)

    • getOldQty

      @Nullable public String getOldQty()
      used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'.
      Returns:
      oldQty

    • setOldQty

      public void setOldQty(@Nullable String oldQty)

    • qty

      public OpcaUSPLITActivityV2 qty(@Nullable String qty)

    • getQty

      @Nullable public String getQty()
      used when the old contract's quantity is equal to the new contract's quantity. Mutually exclusive with 'old_qty' and 'new_qty'
      Returns:
      qty

    • setQty

      public void setQty(@Nullable String qty)

    • newCusip

      public OpcaUSPLITActivityV2 newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      CUSIP of the new security after the split
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newRate

      public OpcaUSPLITActivityV2 newRate(@Nonnull String newRate)

    • getNewRate

      @Nonnull public String getNewRate()
      Ratio of new shares received
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nonnull String newRate)

    • oldCusip

      public OpcaUSPLITActivityV2 oldCusip(@Nonnull String oldCusip)

    • getOldCusip

      @Nonnull public String getOldCusip()
      CUSIP of the old security before the split
      Returns:
      oldCusip

    • setOldCusip

      public void setOldCusip(@Nonnull String oldCusip)

    • oldRate

      public OpcaUSPLITActivityV2 oldRate(@Nonnull String oldRate)

    • getOldRate

      @Nonnull public String getOldRate()
      Ratio of old shares exchanged
      Returns:
      oldRate

    • setOldRate

      public void setOldRate(@Nonnull String oldRate)

    • payableDate

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

    • alternateCusip

      public OpcaUSPLITActivityV2 alternateCusip(@Nonnull String alternateCusip)

    • getAlternateCusip

      @Nonnull public String getAlternateCusip()
      CUSIP for the alternate security after the split
      Returns:
      alternateCusip

    • setAlternateCusip

      public void setAlternateCusip(@Nonnull String alternateCusip)

    • alternateRate

      public OpcaUSPLITActivityV2 alternateRate(@Nonnull String alternateRate)

    • getAlternateRate

      @Nonnull public String getAlternateRate()
      Ratio of alternate shares received
      Returns:
      alternateRate

    • setAlternateRate

      public void setAlternateRate(@Nonnull String alternateRate)

    • alternateSymbol

      public OpcaUSPLITActivityV2 alternateSymbol(@Nonnull String alternateSymbol)

    • getAlternateSymbol

      @Nonnull public String getAlternateSymbol()
      Symbol for the alternate security after the split
      Returns:
      alternateSymbol

    • setAlternateSymbol

      public void setAlternateSymbol(@Nonnull String alternateSymbol)

    • effectiveDate

      public OpcaUSPLITActivityV2 effectiveDate(@Nonnull LocalDate effectiveDate)

    • getEffectiveDate

      @Nonnull public LocalDate getEffectiveDate()
      When the unit split becomes effective
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nonnull LocalDate effectiveDate)

    • newSymbol

      public OpcaUSPLITActivityV2 newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Symbol of the new security after the unit split
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • oldSymbol

      public OpcaUSPLITActivityV2 oldSymbol(@Nonnull String oldSymbol)

    • getOldSymbol

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

    • setOldSymbol

      public void setOldSymbol(@Nonnull String oldSymbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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