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

Class Locate

java.lang.Object
markets.alpaca.client.openapi.trading.model.Locate
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Locate extends Object implements Serializable
A locate request and its current lifecycle status.
See Also:

  • Field Details

  • Constructor Details

    • Locate

      public Locate()

  • Method Details

    • allOrNone

      public Locate allOrNone(@Nonnull Boolean allOrNone)

    • getAllOrNone

      @Nonnull public Boolean getAllOrNone()
      Whether the request required the full quantity.
      Returns:
      allOrNone

    • setAllOrNone

      public void setAllOrNone(@Nonnull Boolean allOrNone)

    • createdAt

      public Locate createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      Time when the locate was created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • expiresAt

      public Locate expiresAt(@Nullable OffsetDateTime expiresAt)

    • getExpiresAt

      @Nullable public OffsetDateTime getExpiresAt()
      Time when the active locate expires. Omitted when rejected.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable OffsetDateTime expiresAt)

    • id

      public Locate id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      Locate ID.
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • limitPrice

      public Locate limitPrice(@Nullable String limitPrice)

    • getLimitPrice

      @Nullable public String getLimitPrice()
      Maximum acceptable fee per share from the request.
      Returns:
      limitPrice

    • setLimitPrice

      public void setLimitPrice(@Nullable String limitPrice)

    • locatedPrice

      public Locate locatedPrice(@Nullable String locatedPrice)

    • getLocatedPrice

      @Nullable public String getLocatedPrice()
      Locate fee per share in USD. Omitted when rejected.
      Returns:
      locatedPrice

    • setLocatedPrice

      public void setLocatedPrice(@Nullable String locatedPrice)

    • locatedQty

      public Locate locatedQty(@Nullable Long locatedQty)

    • getLocatedQty

      @Nullable public Long getLocatedQty()
      Number of shares located. Omitted when rejected.
      Returns:
      locatedQty

    • setLocatedQty

      public void setLocatedQty(@Nullable Long locatedQty)

    • rejectionReason

      public Locate rejectionReason(@Nullable String rejectionReason)

    • getRejectionReason

      @Nullable public String getRejectionReason()
      Machine-readable rejection reason.
      Returns:
      rejectionReason

    • setRejectionReason

      public void setRejectionReason(@Nullable String rejectionReason)

    • requestedQty

      public Locate requestedQty(@Nonnull Long requestedQty)

    • getRequestedQty

      @Nonnull public Long getRequestedQty()
      Number of shares requested.
      Returns:
      requestedQty

    • setRequestedQty

      public void setRequestedQty(@Nonnull Long requestedQty)

    • status

      public Locate status(@Nonnull LocateStatus status)

    • getStatus

      @Nonnull public LocateStatus getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull LocateStatus status)

    • symbol

      public Locate symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Stock symbol.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • totalFee

      public Locate totalFee(@Nullable String totalFee)

    • getTotalFee

      @Nullable public String getTotalFee()
      Total locate fee in USD. Omitted when rejected.
      Returns:
      totalFee

    • setTotalFee

      public void setTotalFee(@Nullable String totalFee)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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