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

Class WorthlessRemoval

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

  • Field Details

  • Constructor Details

    • WorthlessRemoval

      public WorthlessRemoval()

  • Method Details

    • currency

      public WorthlessRemoval 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 WorthlessRemoval cusip(@Nonnull String cusip)

    • getCusip

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

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • id

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

    • processDate

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

    • symbol

      public WorthlessRemoval symbol(@Nonnull String symbol)

    • getSymbol

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

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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