Package org.onyx.api

Class Transaction.Builder.Action.Retire

All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>
Enclosing class:
Transaction.Builder.Action

public static class Transaction.Builder.Action.Retire extends Transaction.Builder.Action
Moves assets from a source account to a destination account.
See Also:
  • Constructor Details

    • Retire

      public Retire()
  • Method Details

    • setSourceAccountId

      public Transaction.Builder.Action.Retire setSourceAccountId(String id)
      Specifies an account, identified by its ID, as the source of the tokens to be retired. You must specify a source account ID.
      Parameters:
      id - an account ID
      Returns:
      updated action
    • setAssetId

      public Transaction.Builder.Action.Retire setAssetId(String id)
      Specifies the asset, identified by its ID, to be retired.
      Parameters:
      id - ID of an asset
      Returns:
      updated action
    • setAmount

      public Transaction.Builder.Action.Retire setAmount(long amount)
      Specifies the amount to be retired.
      Parameters:
      amount - number of asset units
      Returns:
      updated action
    • setActionTags

      public Transaction.Builder.Action.Retire setActionTags(Map<String,Object> actionTags)
      Specifies tags for the action.
      Parameters:
      actionTags - arbitrary key-value data
      Returns:
      updated action
    • addActionTagsField

      public Transaction.Builder.Action.Retire addActionTagsField(String key, Object value)
      Adds a key-value pair to the tags for the action.
      Parameters:
      key - key of the action tags field
      value - value of action tags field
      Returns:
      updated action
    • setFilter

      public Transaction.Builder.Action.Retire setFilter(String filter)
      Token filter string. See {https://dashboard.seq.com/docs/filters}.
      Parameters:
      filter - a filter expression
      Returns:
      updated action
    • addFilterParameter

      public Transaction.Builder.Action.Retire addFilterParameter(Object param)
      A list of parameter values for filter string (if needed).
      Parameters:
      param - a filter parameter
      Returns:
      updated action