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

Class AdminActionLegacyNote

java.lang.Object
markets.alpaca.client.openapi.broker.model.AdminActionLegacyNote
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AdminActionLegacyNote extends Object implements Serializable
Represents structure of a LegacyNote type AdminAction
See Also:

  • Field Details

  • Constructor Details

    • AdminActionLegacyNote

      public AdminActionLegacyNote()

  • Method Details

    • at

      public AdminActionLegacyNote at(@Nonnull OffsetDateTime at)

    • getAt

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

    • setAt

      public void setAt(@Nonnull OffsetDateTime at)

    • belongsTo

      public AdminActionLegacyNote belongsTo(@Nonnull AdminActionBelongsTo belongsTo)

    • getBelongsTo

      @Nonnull public AdminActionBelongsTo getBelongsTo()
      Get belongsTo
      Returns:
      belongsTo

    • setBelongsTo

      public void setBelongsTo(@Nonnull AdminActionBelongsTo belongsTo)

    • category

      public AdminActionLegacyNote category(@Nonnull AdminActionCategory category)

    • getCategory

      @Nonnull public AdminActionCategory getCategory()
      Get category
      Returns:
      category

    • setCategory

      public void setCategory(@Nonnull AdminActionCategory category)

    • correspondent

      public AdminActionLegacyNote correspondent(@Nonnull String correspondent)

    • getCorrespondent

      @Nonnull public String getCorrespondent()
      Related correspondent
      Returns:
      correspondent

    • setCorrespondent

      public void setCorrespondent(@Nonnull String correspondent)

    • createdBy

      public AdminActionLegacyNote createdBy(@Nonnull AdminActionCreatedBy createdBy)

    • getCreatedBy

      @Nonnull public AdminActionCreatedBy getCreatedBy()
      Get createdBy
      Returns:
      createdBy

    • setCreatedBy

      public void setCreatedBy(@Nonnull AdminActionCreatedBy createdBy)

    • eventId

      public AdminActionLegacyNote eventId(@Nonnull String eventId)

    • getEventId

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

    • setEventId

      public void setEventId(@Nonnull String eventId)

    • note

      public AdminActionLegacyNote note(@Nonnull String note)

    • getNote

      @Nonnull public String getNote()
      Free text form description of the admin action
      Returns:
      note

    • setNote

      public void setNote(@Nonnull String note)

    • replacesEventId

      public AdminActionLegacyNote replacesEventId(@Nullable String replacesEventId)

    • getReplacesEventId

      @Nullable public String getReplacesEventId()
      Id of the replaced event (optional)
      Returns:
      replacesEventId

    • setReplacesEventId

      public void setReplacesEventId(@Nullable String replacesEventId)

    • type

      public AdminActionLegacyNote type(@Nonnull AdminActionType type)

    • getType

      @Nonnull public AdminActionType getType()
      Get type
      Returns:
      type

    • setType

      public void setType(@Nonnull AdminActionType type)

    • visibility

      public AdminActionLegacyNote visibility(@Nonnull AdminActionVisibility visibility)

    • getVisibility

      @Nonnull public AdminActionVisibility getVisibility()
      Get visibility
      Returns:
      visibility

    • setVisibility

      public void setVisibility(@Nonnull AdminActionVisibility visibility)

    • context

      public AdminActionLegacyNote context(@Nonnull Object context)

    • getContext

      @Nonnull public Object getContext()
      Variable schema type which depends on the type
      Returns:
      context

    • setContext

      public void setContext(@Nonnull Object context)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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