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

Class CashMerger

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

  • Field Details

  • Constructor Details

    • CashMerger

      public CashMerger()

  • Method Details

    • acquireeCusip

      public CashMerger acquireeCusip(@Nonnull String acquireeCusip)

    • getAcquireeCusip

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

    • setAcquireeCusip

      public void setAcquireeCusip(@Nonnull String acquireeCusip)

    • acquireeIsin

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

    • acquireeSymbol

      public CashMerger acquireeSymbol(@Nonnull String acquireeSymbol)

    • getAcquireeSymbol

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

    • setAcquireeSymbol

      public void setAcquireeSymbol(@Nonnull String acquireeSymbol)

    • acquirerCusip

      public CashMerger acquirerCusip(@Nullable String acquirerCusip)

    • getAcquirerCusip

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

    • setAcquirerCusip

      public void setAcquirerCusip(@Nullable String acquirerCusip)

    • acquirerIsin

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

    • acquirerSymbol

      public CashMerger acquirerSymbol(@Nullable String acquirerSymbol)

    • getAcquirerSymbol

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

    • setAcquirerSymbol

      public void setAcquirerSymbol(@Nullable String acquirerSymbol)

    • currency

      public CashMerger 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 CashMerger 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 CashMerger 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 CashMerger 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 CashMerger 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 CashMerger rate(@Nonnull Double rate)

    • getRate

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

    • setRate

      public void setRate(@Nonnull Double rate)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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