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

Class CaEventWorthlessRemoval

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventWorthlessRemoval
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventWorthlessRemoval extends Object implements Serializable
Worthless removal payload delivered when `event_type == worthless_removal_corporateaction_event`. Corresponds to `worthless_removals` on the REST [`GET /v1/corporate-actions`](#operation/CorporateActions) response.
See Also:

  • Field Details

  • Constructor Details

    • CaEventWorthlessRemoval

      public CaEventWorthlessRemoval()

  • Method Details

    • id

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

    • processDate

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

    • currency

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

    • getCusip

      @Nonnull public String getCusip()
      CUSIP of the security.
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • isin

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

    • symbol

      public CaEventWorthlessRemoval symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Ticker being removed.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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