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

Class PartialCall

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

  • Field Details

  • Constructor Details

    • PartialCall

      public PartialCall()

  • Method Details

    • currency

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

    • cusip

      public PartialCall cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      Get cusip
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • dividendRate

      public PartialCall dividendRate(@Nullable Double dividendRate)

    • getDividendRate

      @Nullable public Double getDividendRate()
      Get dividendRate
      Returns:
      dividendRate

    • setDividendRate

      public void setDividendRate(@Nullable Double dividendRate)

    • id

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

    • isin

      public PartialCall isin(@Nullable String isin)

    • getIsin

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

    • setIsin

      public void setIsin(@Nullable String isin)

    • lotteryDate

      public PartialCall lotteryDate(@Nullable LocalDate lotteryDate)

    • getLotteryDate

      @Nullable public LocalDate getLotteryDate()
      Get lotteryDate
      Returns:
      lotteryDate

    • setLotteryDate

      public void setLotteryDate(@Nullable LocalDate lotteryDate)

    • lotteryType

      public PartialCall lotteryType(@Nullable PartialCall.LotteryTypeEnum lotteryType)

    • getLotteryType

      @Nullable public PartialCall.LotteryTypeEnum getLotteryType()
      The type of lottery for the partial call.
      Returns:
      lotteryType

    • setLotteryType

      public void setLotteryType(@Nullable PartialCall.LotteryTypeEnum lotteryType)

    • payableDate

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

    • price

      public PartialCall price(@Nullable Double price)

    • getPrice

      @Nullable public Double getPrice()
      Get price
      Returns:
      price

    • setPrice

      public void setPrice(@Nullable Double price)

    • processDate

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

    • recordDate

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

    • resultsPublicationDate

      public PartialCall resultsPublicationDate(@Nullable LocalDate resultsPublicationDate)

    • getResultsPublicationDate

      @Nullable public LocalDate getResultsPublicationDate()
      Get resultsPublicationDate
      Returns:
      resultsPublicationDate

    • setResultsPublicationDate

      public void setResultsPublicationDate(@Nullable LocalDate resultsPublicationDate)

    • symbol

      public PartialCall symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Get symbol
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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