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

Class CaEventBase

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventBase
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventBase extends Object implements Serializable
Common fields present on every `ca` payload regardless of `event_type`. Not meant to be referenced directly by clients -- it exists so each per-type payload schema (`ca_event_cash_dividend`, `ca_event_forward_split`, ...) can `allOf`-compose it instead of restating `id` and `process_date`. This makes the \"always present\" invariant structural (guaranteed by the schema) rather than emergent from repetition, and matches the \"Common `ca` fields\" section of the event-streaming Corporate Actions SSE design doc.
See Also:

  • Field Details

  • Constructor Details

    • CaEventBase

      public CaEventBase()

  • Method Details

    • id

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

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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