Package markets.alpaca.client.openapi.broker.model

Class NonTradeActivityEvent

java.lang.Object
markets.alpaca.client.openapi.broker.model.NonTradeActivityEvent
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class NonTradeActivityEvent extends Object implements Serializable
Represents a non-trade activity SSE event
See Also:

  • Field Details

  • Constructor Details

    • NonTradeActivityEvent

      public NonTradeActivityEvent()

  • Method Details

    • accountId

      public NonTradeActivityEvent accountId(@Nonnull UUID accountId)

    • getAccountId

      @Nonnull public UUID getAccountId()
      Account UUID
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nonnull UUID accountId)

    • at

      public NonTradeActivityEvent at(@Nonnull OffsetDateTime at)

    • getAt

      @Nonnull public OffsetDateTime getAt()
      Timestamp of when the event was emitted
      Returns:
      at

    • setAt

      public void setAt(@Nonnull OffsetDateTime at)

    • cusip

      public NonTradeActivityEvent cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      CUSIP the event is associated with, not present when no CUSIP is applicable
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • description

      public NonTradeActivityEvent description(@Nonnull String description)

    • getDescription

      @Nonnull public String getDescription()
      Additional information about the event, empty string if not applicable
      Returns:
      description

    • setDescription

      public void setDescription(@Nonnull String description)

    • entryType

      public NonTradeActivityEvent entryType(@Nonnull String entryType)

    • getEntryType

      @Nonnull public String getEntryType()
      Type of entry for e.g JNLC, FEE, INT, DIVNRA etc
      Returns:
      entryType

    • setEntryType

      public void setEntryType(@Nonnull String entryType)

    • eventId

      public NonTradeActivityEvent eventId(@Nullable Integer eventId)

    • getEventId

      @Nullable public Integer getEventId()
      Monotonically increasing 64bit integer
      Returns:
      eventId

    • setEventId

      public void setEventId(@Nullable Integer eventId)

    • eventUlid

      public NonTradeActivityEvent eventUlid(@Nonnull String eventUlid)

    • getEventUlid

      @Nonnull public String getEventUlid()
      lexically sortable, monotonically increasing character array
      Returns:
      eventUlid

    • setEventUlid

      public void setEventUlid(@Nonnull String eventUlid)

    • id

      public NonTradeActivityEvent id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      Record UUID
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • netAmount

      public NonTradeActivityEvent netAmount(@Nonnull BigDecimal netAmount)

    • getNetAmount

      @Nonnull public BigDecimal getNetAmount()
      Net amount if applicable, 0 otherwise
      Returns:
      netAmount

    • setNetAmount

      public void setNetAmount(@Nonnull BigDecimal netAmount)

    • perShareAmount

      public NonTradeActivityEvent perShareAmount(@Nullable BigDecimal perShareAmount)

    • getPerShareAmount

      @Nullable public BigDecimal getPerShareAmount()
      Per share amount if applicable
      Returns:
      perShareAmount

    • setPerShareAmount

      public void setPerShareAmount(@Nullable BigDecimal perShareAmount)

    • price

      public NonTradeActivityEvent price(@Nullable BigDecimal price)

    • getPrice

      @Nullable public BigDecimal getPrice()
      Price if applicable.
      Returns:
      price

    • setPrice

      public void setPrice(@Nullable BigDecimal price)

    • qty

      public NonTradeActivityEvent qty(@Nullable BigDecimal qty)

    • getQty

      @Nullable public BigDecimal getQty()
      Quantity of the stock affected. 0 for cash events
      Returns:
      qty

    • setQty

      public void setQty(@Nullable BigDecimal qty)

    • settleDate

      public NonTradeActivityEvent settleDate(@Nonnull LocalDate settleDate)

    • getSettleDate

      @Nonnull public LocalDate getSettleDate()
      Date of settlement if applicable
      Returns:
      settleDate

    • setSettleDate

      public void setSettleDate(@Nonnull LocalDate settleDate)

    • status

      public NonTradeActivityEvent status(@Nullable NonTradeActivityEvent.StatusEnum status)

    • getStatus

      @Nullable public NonTradeActivityEvent.StatusEnum getStatus()
      Status of the event
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable NonTradeActivityEvent.StatusEnum status)

    • symbol

      public NonTradeActivityEvent symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      Symbol the event is associated with, empty string when no symbol is applicable
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • systemDate

      public NonTradeActivityEvent systemDate(@Nonnull LocalDate systemDate)

    • getSystemDate

      @Nonnull public LocalDate getSystemDate()
      Date of the event recorded in the system
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nonnull LocalDate systemDate)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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