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

Class AdminActionEventGeneral

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

  • Field Details

  • Constructor Details

    • AdminActionEventGeneral

      public AdminActionEventGeneral()

  • Method Details

    • at

      public AdminActionEventGeneral at(@Nonnull OffsetDateTime at)

    • getAt

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

    • setAt

      public void setAt(@Nonnull OffsetDateTime at)

    • belongsTo

      public AdminActionEventGeneral belongsTo(@Nonnull AdminActionBelongsTo belongsTo)

    • getBelongsTo

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

    • setBelongsTo

      public void setBelongsTo(@Nonnull AdminActionBelongsTo belongsTo)

    • category

      public AdminActionEventGeneral category(@Nonnull AdminActionCategory category)

    • getCategory

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

    • setCategory

      public void setCategory(@Nonnull AdminActionCategory category)

    • correspondent

      public AdminActionEventGeneral correspondent(@Nonnull String correspondent)

    • getCorrespondent

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

    • setCorrespondent

      public void setCorrespondent(@Nonnull String correspondent)

    • createdBy

      public AdminActionEventGeneral createdBy(@Nonnull AdminActionCreatedBy createdBy)

    • getCreatedBy

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

    • setCreatedBy

      public void setCreatedBy(@Nonnull AdminActionCreatedBy createdBy)

    • eventId

      public AdminActionEventGeneral 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 AdminActionEventGeneral 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 AdminActionEventGeneral 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 AdminActionEventGeneral type(@Nonnull AdminActionType type)

    • getType

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

    • setType

      public void setType(@Nonnull AdminActionType type)

    • visibility

      public AdminActionEventGeneral visibility(@Nonnull AdminActionVisibility visibility)

    • getVisibility

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

    • setVisibility

      public void setVisibility(@Nonnull AdminActionVisibility visibility)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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