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

Class StockAndCashMerger

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

  • Field Details

  • Constructor Details

    • StockAndCashMerger

      public StockAndCashMerger()

  • Method Details

    • acquireeCusip

      public StockAndCashMerger acquireeCusip(@Nonnull String acquireeCusip)

    • getAcquireeCusip

      @Nonnull public String getAcquireeCusip()
      Get acquireeCusip
      Returns:
      acquireeCusip

    • setAcquireeCusip

      public void setAcquireeCusip(@Nonnull String acquireeCusip)

    • acquireeIsin

      public StockAndCashMerger acquireeIsin(@Nullable String acquireeIsin)

    • getAcquireeIsin

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

    • setAcquireeIsin

      public void setAcquireeIsin(@Nullable String acquireeIsin)

    • acquireeRate

      public StockAndCashMerger acquireeRate(@Nonnull Double acquireeRate)

    • getAcquireeRate

      @Nonnull public Double getAcquireeRate()
      Get acquireeRate
      Returns:
      acquireeRate

    • setAcquireeRate

      public void setAcquireeRate(@Nonnull Double acquireeRate)

    • acquireeSymbol

      public StockAndCashMerger acquireeSymbol(@Nonnull String acquireeSymbol)

    • getAcquireeSymbol

      @Nonnull public String getAcquireeSymbol()
      Get acquireeSymbol
      Returns:
      acquireeSymbol

    • setAcquireeSymbol

      public void setAcquireeSymbol(@Nonnull String acquireeSymbol)

    • acquirerCusip

      public StockAndCashMerger acquirerCusip(@Nonnull String acquirerCusip)

    • getAcquirerCusip

      @Nonnull public String getAcquirerCusip()
      Get acquirerCusip
      Returns:
      acquirerCusip

    • setAcquirerCusip

      public void setAcquirerCusip(@Nonnull String acquirerCusip)

    • acquirerIsin

      public StockAndCashMerger acquirerIsin(@Nullable String acquirerIsin)

    • getAcquirerIsin

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

    • setAcquirerIsin

      public void setAcquirerIsin(@Nullable String acquirerIsin)

    • acquirerRate

      public StockAndCashMerger acquirerRate(@Nonnull Double acquirerRate)

    • getAcquirerRate

      @Nonnull public Double getAcquirerRate()
      Get acquirerRate
      Returns:
      acquirerRate

    • setAcquirerRate

      public void setAcquirerRate(@Nonnull Double acquirerRate)

    • acquirerSymbol

      public StockAndCashMerger acquirerSymbol(@Nonnull String acquirerSymbol)

    • getAcquirerSymbol

      @Nonnull public String getAcquirerSymbol()
      Get acquirerSymbol
      Returns:
      acquirerSymbol

    • setAcquirerSymbol

      public void setAcquirerSymbol(@Nonnull String acquirerSymbol)

    • cashRate

      public StockAndCashMerger cashRate(@Nonnull Double cashRate)

    • getCashRate

      @Nonnull public Double getCashRate()
      Get cashRate
      Returns:
      cashRate

    • setCashRate

      public void setCashRate(@Nonnull Double cashRate)

    • currency

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

    • effectiveDate

      public StockAndCashMerger effectiveDate(@Nonnull LocalDate effectiveDate)

    • getEffectiveDate

      @Nonnull public LocalDate getEffectiveDate()
      The effective date marks the cutoff point for shareholders to be credited.
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nonnull LocalDate effectiveDate)

    • id

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

    • payableDate

      public StockAndCashMerger payableDate(@Nullable LocalDate payableDate)

    • getPayableDate

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

    • setPayableDate

      public void setPayableDate(@Nullable LocalDate payableDate)

    • processDate

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

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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