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

Class OptionDeliverable

java.lang.Object
markets.alpaca.client.openapi.broker.model.OptionDeliverable
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class OptionDeliverable extends Object implements Serializable
OptionDeliverable
See Also:

  • Field Details

  • Constructor Details

    • OptionDeliverable

      public OptionDeliverable()

  • Method Details

    • allocationPercentage

      public OptionDeliverable allocationPercentage(@Nonnull String allocationPercentage)

    • getAllocationPercentage

      @Nonnull public String getAllocationPercentage()
      Cost allocation percentage of the deliverable. This is used to determine the cost basis of the equity shares received from the exercise, specially for non-standard contracts with multiple deliverables.
      Returns:
      allocationPercentage

    • setAllocationPercentage

      public void setAllocationPercentage(@Nonnull String allocationPercentage)

    • amount

      public OptionDeliverable amount(@Nonnull String amount)

    • getAmount

      @Nonnull public String getAmount()
      The deliverable amount. For cash deliverables, this is the cash amount. For standard contract, this is always 100. This field can be null in case the deliverable settlement is delayed and the amount is yet to be determined.
      Returns:
      amount

    • setAmount

      public void setAmount(@Nonnull String amount)

    • assetId

      public OptionDeliverable assetId(@Nullable String assetId)

    • getAssetId

      @Nullable public String getAssetId()
      Unique identifier of the deliverable asset. For standard contracts, this is equivalent to underlying_asset_id of the contracts. This field is not returned for cash deliverables.
      Returns:
      assetId

    • setAssetId

      public void setAssetId(@Nullable String assetId)

    • delayedSettlement

      public OptionDeliverable delayedSettlement(@Nonnull Boolean delayedSettlement)

    • getDelayedSettlement

      @Nonnull public Boolean getDelayedSettlement()
      If true, the settlement of the deliverable will be delayed. For instance, in the event of a contract with a delayed deliverable being exercised, both the availability of the deliverable and its settlement may be postponed beyond the typical timeframe.
      Returns:
      delayedSettlement

    • setDelayedSettlement

      public void setDelayedSettlement(@Nonnull Boolean delayedSettlement)

    • settlementMethod

      public OptionDeliverable settlementMethod(@Nonnull OptionDeliverable.SettlementMethodEnum settlementMethod)

    • getSettlementMethod

      @Nonnull public OptionDeliverable.SettlementMethodEnum getSettlementMethod()
      Indicates the settlement method that will be used: - **BTOB**: Broker to Broker - **CADF**: Cash Difference - **CAFX**: Cash Fixed - **CCC**: Correspondent Clearing Corp
      Returns:
      settlementMethod

    • setSettlementMethod

      public void setSettlementMethod(@Nonnull OptionDeliverable.SettlementMethodEnum settlementMethod)

    • settlementType

      public OptionDeliverable settlementType(@Nonnull OptionDeliverable.SettlementTypeEnum settlementType)

    • getSettlementType

      @Nonnull public OptionDeliverable.SettlementTypeEnum getSettlementType()
      Indicates when the deliverable will be settled if the contract is exercised/assigned.
      Returns:
      settlementType

    • setSettlementType

      public void setSettlementType(@Nonnull OptionDeliverable.SettlementTypeEnum settlementType)

    • symbol

      public OptionDeliverable symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Symbol of the deliverable. For standard contracts, this is equivalent to the underlying symbol of the contract.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • type

      public OptionDeliverable type(@Nonnull OptionDeliverable.TypeEnum type)

    • getType

      @Nonnull public OptionDeliverable.TypeEnum getType()
      Type of deliverable, indicating whether it's cash or equity. For standard contracts, it is always \"equity\".
      Returns:
      type

    • setType

      public void setType(@Nonnull OptionDeliverable.TypeEnum type)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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