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

Class CaEventNameChange

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

  • Field Details

  • Constructor Details

    • CaEventNameChange

      public CaEventNameChange()

  • Method Details

    • id

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

    • newCusip

      public CaEventNameChange newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      CUSIP after the change.
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newIsin

      public CaEventNameChange newIsin(@Nullable String newIsin)

    • getNewIsin

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

    • setNewIsin

      public void setNewIsin(@Nullable String newIsin)

    • newSymbol

      public CaEventNameChange newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Ticker after the change.
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • oldCusip

      public CaEventNameChange oldCusip(@Nonnull String oldCusip)

    • getOldCusip

      @Nonnull public String getOldCusip()
      CUSIP before the change.
      Returns:
      oldCusip

    • setOldCusip

      public void setOldCusip(@Nonnull String oldCusip)

    • oldIsin

      public CaEventNameChange oldIsin(@Nullable String oldIsin)

    • getOldIsin

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

    • setOldIsin

      public void setOldIsin(@Nullable String oldIsin)

    • oldSymbol

      public CaEventNameChange oldSymbol(@Nonnull String oldSymbol)

    • getOldSymbol

      @Nonnull public String getOldSymbol()
      Ticker before the change.
      Returns:
      oldSymbol

    • setOldSymbol

      public void setOldSymbol(@Nonnull String oldSymbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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