Package markets.alpaca.client.openapi.trading.model

Class Watchlist

java.lang.Object
markets.alpaca.client.openapi.trading.model.Watchlist
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Watchlist extends Object implements Serializable
The watchlist API provides CRUD operation for the account's watchlist. An account can have multiple watchlists and each is uniquely identified by id but can also be addressed by user-defined name. Each watchlist is an ordered list of assets.
See Also:

  • Field Details

  • Constructor Details

    • Watchlist

      public Watchlist()

  • Method Details

    • accountId

      public Watchlist accountId(@Nonnull UUID accountId)

    • getAccountId

      @Nonnull public UUID getAccountId()
      account ID
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nonnull UUID accountId)

    • assets

      public Watchlist assets(@Nullable List<Assets> assets)

    • addAssetsItem

      public Watchlist addAssetsItem(Assets assetsItem)

    • getAssets

      @Nullable public List<Assets> getAssets()
      the content of this watchlist, in the order as registered by the client
      Returns:
      assets

    • setAssets

      public void setAssets(@Nullable List<Assets> assets)

    • createdAt

      public Watchlist createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      Get createdAt
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • id

      public Watchlist id(@Nonnull UUID id)

    • getId

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

    • setId

      public void setId(@Nonnull UUID id)

    • name

      public Watchlist name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      user-defined watchlist name (up to 64 characters)
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • updatedAt

      public Watchlist updatedAt(@Nonnull OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nonnull public OffsetDateTime getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nonnull OffsetDateTime updatedAt)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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