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

Class JournalStatusEventV2

java.lang.Object
markets.alpaca.client.openapi.broker.model.JournalStatusEventV2
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class JournalStatusEventV2 extends Object implements Serializable
Represents a change in a Journal's status, sent over the events streaming api.
See Also:

  • Field Details

  • Constructor Details

    • JournalStatusEventV2

      public JournalStatusEventV2()

  • Method Details

    • at

      public JournalStatusEventV2 at(@Nonnull OffsetDateTime at)

    • getAt

      @Nonnull public OffsetDateTime getAt()
      Timestamp of event
      Returns:
      at

    • setAt

      public void setAt(@Nonnull OffsetDateTime at)

    • batchErrorMessage

      public JournalStatusEventV2 batchErrorMessage(@Nullable String batchErrorMessage)

    • getBatchErrorMessage

      @Nullable public String getBatchErrorMessage()
      If journal submitted in batch (that is, idempotency_key_type is batch), this is the error message of the batch journal execution.
      Returns:
      batchErrorMessage

    • setBatchErrorMessage

      public void setBatchErrorMessage(@Nullable String batchErrorMessage)

    • description

      public JournalStatusEventV2 description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      The description of the journal event when submitted
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • entryType

      public JournalStatusEventV2 entryType(@Nonnull JournalEntryType entryType)

    • getEntryType

      @Nonnull public JournalEntryType getEntryType()
      Get entryType
      Returns:
      entryType

    • setEntryType

      public void setEntryType(@Nonnull JournalEntryType entryType)

    • eventId

      public JournalStatusEventV2 eventId(@Nonnull String eventId)

    • getEventId

      @Nonnull public String getEventId()
      lexically sortable, monotonically increasing character array
      Returns:
      eventId

    • setEventId

      public void setEventId(@Nonnull String eventId)

    • idempotencyKey

      public JournalStatusEventV2 idempotencyKey(@Nullable UUID idempotencyKey)

    • getIdempotencyKey

      @Nullable public UUID getIdempotencyKey()
      The idempotency key of the journal event
      Returns:
      idempotencyKey

    • setIdempotencyKey

      public void setIdempotencyKey(@Nullable UUID idempotencyKey)

    • idempotencyKeyType

      public JournalStatusEventV2 idempotencyKeyType(@Nullable JournalStatusEventV2.IdempotencyKeyTypeEnum idempotencyKeyType)

    • getIdempotencyKeyType

      @Nullable public JournalStatusEventV2.IdempotencyKeyTypeEnum getIdempotencyKeyType()
      The type of idempotency key
      Returns:
      idempotencyKeyType

    • setIdempotencyKeyType

      public void setIdempotencyKeyType(@Nullable JournalStatusEventV2.IdempotencyKeyTypeEnum idempotencyKeyType)

    • journalId

      public JournalStatusEventV2 journalId(@Nonnull UUID journalId)

    • getJournalId

      @Nonnull public UUID getJournalId()
      The UUID of the related Journal
      Returns:
      journalId

    • setJournalId

      public void setJournalId(@Nonnull UUID journalId)

    • statusFrom

      public JournalStatusEventV2 statusFrom(@Nonnull JournalStatus statusFrom)

    • getStatusFrom

      @Nonnull public JournalStatus getStatusFrom()
      Get statusFrom
      Returns:
      statusFrom

    • setStatusFrom

      public void setStatusFrom(@Nonnull JournalStatus statusFrom)

    • statusTo

      public JournalStatusEventV2 statusTo(@Nonnull JournalStatus statusTo)

    • getStatusTo

      @Nonnull public JournalStatus getStatusTo()
      Get statusTo
      Returns:
      statusTo

    • setStatusTo

      public void setStatusTo(@Nonnull JournalStatus statusTo)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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