Package org.onyx.api
Class Transaction.Builder.Action.Retire
java.lang.Object
java.util.AbstractMap<String,Object>
java.util.HashMap<String,Object>
org.onyx.api.Transaction.Builder.Action
org.onyx.api.Transaction.Builder.Action.Retire
- All Implemented Interfaces:
Serializable,Cloneable,Map<String,Object>
- Enclosing class:
Transaction.Builder.Action
Moves assets from a source account to a destination account.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.onyx.api.Transaction.Builder.Action
Transaction.Builder.Action.Issue, Transaction.Builder.Action.Retire, Transaction.Builder.Action.TransferNested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K, V> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddActionTagsField(String key, Object value) Adds a key-value pair to the tags for the action.addFilterParameter(Object param) A list of parameter values for filter string (if needed).setActionTags(Map<String, Object> actionTags) Specifies tags for the action.setAmount(long amount) Specifies the amount to be retired.setAssetId(String id) Specifies the asset, identified by its ID, to be retired.Token filter string.Specifies an account, identified by its ID, as the source of the tokens to be retired.Methods inherited from class org.onyx.api.Transaction.Builder.Action
addKeyValueField, addListItemMethods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, valuesMethods inherited from class java.util.AbstractMap
equals, hashCode, toString
-
Constructor Details
-
Retire
public Retire()
-
-
Method Details
-
setSourceAccountId
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
Specifies the asset, identified by its ID, to be retired.- Parameters:
id- ID of an asset- Returns:
- updated action
-
setAmount
Specifies the amount to be retired.- Parameters:
amount- number of asset units- Returns:
- updated action
-
setActionTags
Specifies tags for the action.- Parameters:
actionTags- arbitrary key-value data- Returns:
- updated action
-
addActionTagsField
Adds a key-value pair to the tags for the action.- Parameters:
key- key of the action tags fieldvalue- value of action tags field- Returns:
- updated action
-
setFilter
Token filter string. See {https://dashboard.seq.com/docs/filters}.- Parameters:
filter- a filter expression- Returns:
- updated action
-
addFilterParameter
A list of parameter values for filter string (if needed).- Parameters:
param- a filter parameter- Returns:
- updated action
-