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

Class AdvancedInstructions

java.lang.Object
markets.alpaca.client.openapi.broker.model.AdvancedInstructions
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AdvancedInstructions extends Object implements Serializable
Advanced instructions for Direct Market Access (DMA) routing. When `algorithm` is `DMA`, the order is routed directly to the exchange specified in `destination`. Note that this feature is only available to partners/correspondents who have been enabled for DMA.
See Also:

  • Field Details

  • Constructor Details

    • AdvancedInstructions

      public AdvancedInstructions()

  • Method Details

    • algorithm

      public AdvancedInstructions algorithm(@Nullable AdvancedInstructions.AlgorithmEnum algorithm)

    • getAlgorithm

      @Nullable public AdvancedInstructions.AlgorithmEnum getAlgorithm()
      The advanced routing algorithm to use for the order. Only `DMA` (Direct Market Access) is supported.
      Returns:
      algorithm

    • setAlgorithm

      public void setAlgorithm(@Nullable AdvancedInstructions.AlgorithmEnum algorithm)

    • destination

      public AdvancedInstructions destination(@Nullable AdvancedInstructions.DestinationEnum destination)

    • getDestination

      @Nullable public AdvancedInstructions.DestinationEnum getDestination()
      Target exchange for order execution. Required when `algorithm` is `DMA`.
      Returns:
      destination

    • setDestination

      public void setDestination(@Nullable AdvancedInstructions.DestinationEnum destination)

    • displayQty

      public AdvancedInstructions displayQty(@Nullable BigDecimal displayQty)

    • getDisplayQty

      @Nullable public BigDecimal getDisplayQty()
      Maximum shares displayed on the exchange at any time. Must be in round lot increments.
      Returns:
      displayQty

    • setDisplayQty

      public void setDisplayQty(@Nullable BigDecimal displayQty)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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