Package markets.alpaca.client.openapi.data.model

Class CaEventRightsDistribution

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventRightsDistribution
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventRightsDistribution extends Object implements Serializable
Rights distribution payload delivered when `event_type == rights_distribution_corporateaction_event`. Corresponds to `rights_distributions` on the REST [`GET /v1/corporate-actions`](#operation/CorporateActions) response, but every decimal field is emitted as a JSON string to preserve precision on the wire.
See Also:

  • Field Details

  • Constructor Details

    • CaEventRightsDistribution

      public CaEventRightsDistribution()

  • Method Details

    • id

      public CaEventRightsDistribution id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      The internal Alpaca identifier of the corporate action.
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • processDate

      public CaEventRightsDistribution processDate(@Nonnull LocalDate processDate)

    • getProcessDate

      @Nonnull public LocalDate getProcessDate()
      The date when the corporate action is processed by Alpaca.
      Returns:
      processDate

    • setProcessDate

      public void setProcessDate(@Nonnull LocalDate processDate)

    • currency

      public CaEventRightsDistribution currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      The ISO 4217 currency code associated with the corporate action. Empty value can mean USD, non-applicable (e.g. for name changes) or unknown (can change later to a valid currency).
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • exDate

      public CaEventRightsDistribution exDate(@Nonnull LocalDate exDate)

    • getExDate

      @Nonnull public LocalDate getExDate()
      The ex-date marks the cutoff point for shareholders to be credited.
      Returns:
      exDate

    • setExDate

      public void setExDate(@Nonnull LocalDate exDate)

    • expirationDate

      public CaEventRightsDistribution expirationDate(@Nullable LocalDate expirationDate)

    • getExpirationDate

      @Nullable public LocalDate getExpirationDate()
      Get expirationDate
      Returns:
      expirationDate

    • setExpirationDate

      public void setExpirationDate(@Nullable LocalDate expirationDate)

    • newCusip

      public CaEventRightsDistribution newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      CUSIP of the new right.
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newIsin

      public CaEventRightsDistribution newIsin(@Nullable String newIsin)

    • getNewIsin

      @Nullable public String getNewIsin()
      International Securities Identification Number (ISIN) as defined by ISO 6166. May be empty for US corporate actions.
      Returns:
      newIsin

    • setNewIsin

      public void setNewIsin(@Nullable String newIsin)

    • newSymbol

      public CaEventRightsDistribution newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Ticker of the new right/warrant.
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • payableDate

      public CaEventRightsDistribution payableDate(@Nonnull LocalDate payableDate)

    • getPayableDate

      @Nonnull public LocalDate getPayableDate()
      The date when the corporate action benefit is paid or distributed.
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nonnull LocalDate payableDate)

    • rate

      public CaEventRightsDistribution rate(@Nonnull String rate)

    • getRate

      @Nonnull public String getRate()
      Rights given per share you own, as a decimal string.
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull String rate)

    • recordDate

      public CaEventRightsDistribution recordDate(@Nullable LocalDate recordDate)

    • getRecordDate

      @Nullable public LocalDate getRecordDate()
      The date shareholders must own shares to receive the benefit.
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable LocalDate recordDate)

    • sourceCusip

      public CaEventRightsDistribution sourceCusip(@Nonnull String sourceCusip)

    • getSourceCusip

      @Nonnull public String getSourceCusip()
      CUSIP of the underlying ticker.
      Returns:
      sourceCusip

    • setSourceCusip

      public void setSourceCusip(@Nonnull String sourceCusip)

    • sourceIsin

      public CaEventRightsDistribution sourceIsin(@Nullable String sourceIsin)

    • getSourceIsin

      @Nullable public String getSourceIsin()
      International Securities Identification Number (ISIN) as defined by ISO 6166. May be empty for US corporate actions.
      Returns:
      sourceIsin

    • setSourceIsin

      public void setSourceIsin(@Nullable String sourceIsin)

    • sourceSymbol

      public CaEventRightsDistribution sourceSymbol(@Nonnull String sourceSymbol)

    • getSourceSymbol

      @Nonnull public String getSourceSymbol()
      Ticker whose holders receive the rights.
      Returns:
      sourceSymbol

    • setSourceSymbol

      public void setSourceSymbol(@Nonnull String sourceSymbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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