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

Class RightsDistribution

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

  • Field Details

  • Constructor Details

    • RightsDistribution

      public RightsDistribution()

  • Method Details

    • currency

      public RightsDistribution 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 RightsDistribution 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 RightsDistribution expirationDate(@Nullable LocalDate expirationDate)

    • getExpirationDate

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

    • setExpirationDate

      public void setExpirationDate(@Nullable LocalDate expirationDate)

    • id

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

    • newCusip

      public RightsDistribution newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      Get newCusip
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newIsin

      public RightsDistribution 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 RightsDistribution newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Get newSymbol
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • payableDate

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

    • processDate

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

    • rate

      public RightsDistribution rate(@Nonnull Double rate)

    • getRate

      @Nonnull public Double getRate()
      Get rate
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull Double rate)

    • recordDate

      public RightsDistribution 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 RightsDistribution sourceCusip(@Nonnull String sourceCusip)

    • getSourceCusip

      @Nonnull public String getSourceCusip()
      Get sourceCusip
      Returns:
      sourceCusip

    • setSourceCusip

      public void setSourceCusip(@Nonnull String sourceCusip)

    • sourceIsin

      public RightsDistribution 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 RightsDistribution sourceSymbol(@Nonnull String sourceSymbol)

    • getSourceSymbol

      @Nonnull public String getSourceSymbol()
      Get sourceSymbol
      Returns:
      sourceSymbol

    • setSourceSymbol

      public void setSourceSymbol(@Nonnull String sourceSymbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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