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

Class ExerciseResponse

java.lang.Object
markets.alpaca.client.openapi.broker.model.ExerciseResponse
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExerciseResponse extends Object implements Serializable
Response to an exercise request. This will return the total quantity of contracts exercised as well as the quantity of remaining contracts.
See Also:

  • Field Details

  • Constructor Details

    • ExerciseResponse

      public ExerciseResponse()

  • Method Details

    • qtyExercised

      public ExerciseResponse qtyExercised(@Nullable BigDecimal qtyExercised)

    • getQtyExercised

      @Nullable public BigDecimal getQtyExercised()
      The total quantity of contracts exercised.
      Returns:
      qtyExercised

    • setQtyExercised

      public void setQtyExercised(@Nullable BigDecimal qtyExercised)

    • qtyRemaining

      public ExerciseResponse qtyRemaining(@Nullable BigDecimal qtyRemaining)

    • getQtyRemaining

      @Nullable public BigDecimal getQtyRemaining()
      The total quantity of contracts remaining after the exercise.
      Returns:
      qtyRemaining

    • setQtyRemaining

      public void setQtyRemaining(@Nullable BigDecimal qtyRemaining)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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