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

Class ExerciseRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.ExerciseRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExerciseRequest extends Object implements Serializable
Request to exercise an option contract for an account. This can be omitted or left empty, but it also allows for optionally charging a commission for exercising or specifying a specific quantity of contracts to exercise (rather than the full quantity of contracts held).
See Also:

  • Field Details

  • Constructor Details

    • ExerciseRequest

      public ExerciseRequest()

  • Method Details

    • commission

      public ExerciseRequest commission(@Nullable BigDecimal commission)

    • getCommission

      @Nullable public BigDecimal getCommission()
      The commission you want to collect from the user. (notional amount)
      Returns:
      commission

    • setCommission

      public void setCommission(@Nullable BigDecimal commission)

    • qty

      public ExerciseRequest qty(@Nullable BigDecimal qty)

    • getQty

      @Nullable public BigDecimal getQty()
      The number of contracts to exercise. If not provided, all contracts will be exercised.
      Returns:
      qty

    • setQty

      public void setQty(@Nullable BigDecimal qty)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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