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

Class OpcaMAActivityV2

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

  • Field Details

  • Constructor Details

    • OpcaMAActivityV2

      public OpcaMAActivityV2()

  • Method Details

    • groupId

      public OpcaMAActivityV2 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 OpcaMAActivityV2 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 OpcaMAActivityV2 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 OpcaMAActivityV2 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 OpcaMAActivityV2 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 OpcaMAActivityV2 newContractSymbol(@Nonnull String newContractSymbol)

    • getNewContractSymbol

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

    • setNewContractSymbol

      public void setNewContractSymbol(@Nonnull String newContractSymbol)

    • newQty

      public OpcaMAActivityV2 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 OpcaMAActivityV2 oldContractSymbol(@Nonnull String oldContractSymbol)

    • getOldContractSymbol

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

    • setOldContractSymbol

      public void setOldContractSymbol(@Nonnull String oldContractSymbol)

    • oldQty

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

    • acquireeCusip

      public OpcaMAActivityV2 acquireeCusip(@Nonnull String acquireeCusip)

    • getAcquireeCusip

      @Nonnull public String getAcquireeCusip()
      CUSIP of the acquiree
      Returns:
      acquireeCusip

    • setAcquireeCusip

      public void setAcquireeCusip(@Nonnull String acquireeCusip)

    • acquireeRate

      public OpcaMAActivityV2 acquireeRate(@Nullable String acquireeRate)

    • getAcquireeRate

      @Nullable public String getAcquireeRate()
      Rate of the acquiree
      Returns:
      acquireeRate

    • setAcquireeRate

      public void setAcquireeRate(@Nullable String acquireeRate)

    • acquireeSymbol

      public OpcaMAActivityV2 acquireeSymbol(@Nonnull String acquireeSymbol)

    • getAcquireeSymbol

      @Nonnull public String getAcquireeSymbol()
      Symbol of the acquiree
      Returns:
      acquireeSymbol

    • setAcquireeSymbol

      public void setAcquireeSymbol(@Nonnull String acquireeSymbol)

    • acquirerCusip

      public OpcaMAActivityV2 acquirerCusip(@Nullable String acquirerCusip)

    • getAcquirerCusip

      @Nullable public String getAcquirerCusip()
      CUSIP of the acquirer
      Returns:
      acquirerCusip

    • setAcquirerCusip

      public void setAcquirerCusip(@Nullable String acquirerCusip)

    • acquirerRate

      public OpcaMAActivityV2 acquirerRate(@Nullable String acquirerRate)

    • getAcquirerRate

      @Nullable public String getAcquirerRate()
      Rate of the acquirer
      Returns:
      acquirerRate

    • setAcquirerRate

      public void setAcquirerRate(@Nullable String acquirerRate)

    • acquirerSymbol

      public OpcaMAActivityV2 acquirerSymbol(@Nullable String acquirerSymbol)

    • getAcquirerSymbol

      @Nullable public String getAcquirerSymbol()
      Symbol of the acquirer
      Returns:
      acquirerSymbol

    • setAcquirerSymbol

      public void setAcquirerSymbol(@Nullable String acquirerSymbol)

    • effectiveDate

      public OpcaMAActivityV2 effectiveDate(@Nonnull LocalDate effectiveDate)

    • getEffectiveDate

      @Nonnull public LocalDate getEffectiveDate()
      When the merger/acquisition becomes effective
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nonnull LocalDate effectiveDate)

    • payableDate

      public OpcaMAActivityV2 payableDate(@Nonnull LocalDate payableDate)

    • getPayableDate

      @Nonnull public LocalDate getPayableDate()
      The payable date
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nonnull LocalDate payableDate)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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