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

Class TokenizationRedeemRequest

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

  • Field Details

  • Constructor Details

    • TokenizationRedeemRequest

      public TokenizationRedeemRequest()

  • Method Details

    • accountId

      public TokenizationRedeemRequest accountId(@Nullable UUID accountId)

    • getAccountId

      @Nullable public UUID getAccountId()
      Alpaca account ID (UUID) of the Authorized Participant. Exactly one of `client_id` or `account_id` must be provided to identify the Authorized Participant whose account will receive the underlying asset.
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nullable UUID accountId)

    • clientId

      public TokenizationRedeemRequest clientId(@Nullable String clientId)

    • getClientId

      @Nullable public String getClientId()
      Customer's client identifier on the issuer's platform. Exactly one of `client_id` or `account_id` must be provided to identify the Authorized Participant whose account will receive the underlying asset.
      Returns:
      clientId

    • setClientId

      public void setClientId(@Nullable String clientId)

    • issuerRequestId

      public TokenizationRedeemRequest issuerRequestId(@Nonnull String issuerRequestId)

    • getIssuerRequestId

      @Nonnull public String getIssuerRequestId()
      Unique identifier of the redemption request set by the issuer
      Returns:
      issuerRequestId

    • setIssuerRequestId

      public void setIssuerRequestId(@Nonnull String issuerRequestId)

    • network

      public TokenizationRedeemRequest network(@Nonnull TokenizationNetwork network)

    • getNetwork

      @Nonnull public TokenizationNetwork getNetwork()
      Get network
      Returns:
      network

    • setNetwork

      public void setNetwork(@Nonnull TokenizationNetwork network)

    • qty

      public TokenizationRedeemRequest qty(@Nonnull String qty)

    • getQty

      @Nonnull public String getQty()
      The quantity to convert into the underlying asset. It can be fractional.
      Returns:
      qty

    • setQty

      public void setQty(@Nonnull String qty)

    • tokenSymbol

      public TokenizationRedeemRequest tokenSymbol(@Nonnull String tokenSymbol)

    • getTokenSymbol

      @Nonnull public String getTokenSymbol()
      The tokenized asset symbol
      Returns:
      tokenSymbol

    • setTokenSymbol

      public void setTokenSymbol(@Nonnull String tokenSymbol)

    • txHash

      public TokenizationRedeemRequest txHash(@Nonnull String txHash)

    • getTxHash

      @Nonnull public String getTxHash()
      Transaction hash of the completed request on the blockchain
      Returns:
      txHash

    • setTxHash

      public void setTxHash(@Nonnull String txHash)

    • underlyingSymbol

      public TokenizationRedeemRequest underlyingSymbol(@Nonnull String underlyingSymbol)

    • getUnderlyingSymbol

      @Nonnull public String getUnderlyingSymbol()
      The underlying asset symbol
      Returns:
      underlyingSymbol

    • setUnderlyingSymbol

      public void setUnderlyingSymbol(@Nonnull String underlyingSymbol)

    • walletAddress

      public TokenizationRedeemRequest walletAddress(@Nonnull String walletAddress)

    • getWalletAddress

      @Nonnull public String getWalletAddress()
      The address where the redeemed tokens were originally held
      Returns:
      walletAddress

    • setWalletAddress

      public void setWalletAddress(@Nonnull String walletAddress)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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